#------------------------------------------------------------ # YCE CSV API extensions # # Extend or replace the default set of operations of the YCE csv api # # Specify the task name in the [...] section header # followed by the specific argument list. Each argument must be # defined on a separate line in the order desired. # An argument is mandatory by default, only by appending " = opt" # is an argument optional. # # The argument list does not include the mandatory preamble ('
') # that all csv tasks require ('client_type|service_class|service_type|service_task'). # Those will be added automatically. # # The definition of arguments continues until the next task header is # encountered or the end of file is reached. Comments are anything # folowing a hash ('#') and are ignored. # A task can have an brief description associated using by including # a "brief = My short description of the task" line. # # Any default or extension of the CSV tasks is included in the # sample commands of the CSV API tool with its ccsv header and brief. # The order of these headers can be defined by including a "order = 1" # line with its desired place. Unordered tasks are listed at the bottom. # Tasks with identical ordering are listed alphabetical. # #------------------------------------------------------------ [addCmdbNode] brief = Add cmdb node to service - addcmdbnode | CMDB | generic | api | addcmdbnode order = 1 node # the node short hostname vendor # the node vendor_type. Use NetYCE vendor names fqdn # the node full-qualified-name or ipv4 address Mgmt_vrf_name = opt # the VRF used for backups and filetransfers [addCmdbNode_all] brief = Add cmdb node with all attributes - PRE: addcmdbnode_all | CMDB | generic | api | addcmdbnode_all order = 1 node # the node short hostname vendor # the node vendor_type. Use NetYCE vendor names fqdn # the node full-qualified-name or ipv4 address Mgmt_vrf_name = opt # the VRF used for backups and filetransfers Cmdb_tag = opt Admin_domain = opt Cmdb_attr1 = opt Cmdb_attr2 = opt Cmdb_attr3 = opt Cmdb_attr4 = opt [delCmdbNode] brief = Add cmdb node to service - delcmdbnode | CMDB | generic | api | delcmdbnode order = 2 node [addClient] brief = Add a (new) client to the network order = 3 ClientCode # custom var name are mandatory by default client_name = opt # set var to optional [addSite] brief = Add a (new) site to a client order = 4 ClientCode SiteCode Site_city = opt Site_addr = opt Site_addr_nr = opt Site_zip = opt [addService] brief = Create new service on location. Use specified service_name or default order = 5 ClientCode SiteCode Service [addNode] brief = Adding a node order = 4 ClientCode SiteCode Node_name Vendor_type mgmtip Net_size Node_position Rtr_reserve1 = opt Rtr_reserve2 = opt Rtr_reserve3 = opt [addMplsVrf] brief = Add a Mpls VRF order = 5 Vrf_id Vrf_name Vrf_rd = opt Vrf_as = opt Mpls_management = opt Mpls_type = opt [addVrf] brief = Add a VRF to a Node order = 5 node_name Vrf_id Vrf_template = opt Vrf_rd = opt Vrf_rt = opt Vrf_option_1 = opt Vrf_option_2 = opt [addSupernet] brief = Add a supernet of a given ip-plan to the client order = 8 client_code ip_supernet ip_plan dns_domain = opt [addSubnetVrf] brief = Add a custom subnet with a VRF (needs to exist on the node) order = 9 node_name Net_name Net_descr Net_address Net_size Vrf_id Vlan_template = opt Vlan_id = opt Net_ip_gateway = opt Vrf_template = opt [addVlan] brief = Add a custom vlan order = 9 node_name Net_name Net_descr Vlan_id Vlan_template = opt [addVlanVrf] brief = Add a custom vlan with a VRF (needs to exist on the node) order = 9 node_name Net_name Net_descr Vlan_id Vrf_id Vlan_template = opt Vrf_template = opt Vrf_rd = opt [addVlanVrfPort] brief = Add a custom vlan with a VRF (needs to exist on the node) order = 9 node_name Net_name Net_descr Vlan_id Vrf_id Vlan_template = opt Vrf_template = opt Port_name Port_template Port_description Vrf_rd = opt [addLo] brief = Add a loopback port and subnet and link them. order = 10 node_name Net_name Net_descr Net_address Net_size Port_name Port_descr = opt Port_template = opt Vlan_template = opt Vlan_id = opt Secondary = opt [addLink] brief = Create topology link beteen two ports and reconfigure those order = 10 node_nameA port_nameA node_nameB port_nameB port_shut = opt port_speed = opt port_mode = opt port_chanA = opt port_chanB = opt [chgDomain] brief = Changing values in the domain order = 11 Rme_user Rme_passwd Default_enable_secret [addSubnet] brief = Add a custom subnet. use Node_name to locate the service for this subnet order = 12 Node_name Net_name Net_descr Net_address Net_size Net_ip_gateway Vlan_template = opt Vlan_id = opt [addPort] brief = Add a port. order = 13 Node_name Port_template Port_name Port_reserve1 = opt [addPorts] brief = Add ports. order = 14 Node_name Port_template Port_name lastPort = opt Port_reserve1 = opt [addPo_port] brief = Add Portchannel Port order = 15 Node_name Port_channel Port_name Port_template Port_descripton [linkPortNet] brief = Link a subnet to a port order = 15 Node_name Port_name Net_address [linkPortTplNet] brief = Link a subnet multiple ports using the same template order = 16 Node_name Port_tpl Net_address [linkPortVlan] brief = Link a Vlan to a port order = 17 Node_name Port_name Vlan_id [delNode] brief = deleting a node order = 18 Node_name [delSrv] brief = Deleting the service order = 19 Srv_name [delSrvNode] brief = deleting the service for the respective node order = 20 Node_name