====== Service-type syntax ====== NetYCE currently supports a wide range of service-type commands. These commands total '327' which can be grouped in '19' object types that these commands manipulate. Each object type has its internal alias-type that is used here as the alias-name for simplicity, but should be replaced with more descriptive names for any real-life applications. ^Class name ^Alias type^ |DOMAIN|| |CLIENT|| |SITE|| |SERVICE|| |NODE|| |PORT|| |PORTS|| |LINK|| |SLOT|| |SERVER|| |SUPERNET|| |SUBNET|| |DHCP|| |ADDRESS|| |IPV6_NET|| |IPV6_ADDR|| |MPLS_VRF|| |VRF|| |CMDB|| ===== Domain ===== The ''DOMAIN'' object uses the alias type '''' ^ DOMAIN ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^DOMAIN as new alias^^^^^^^ |ADD |DOMAIN |CURRENT |DOMAIN_NAME |value||create new domain or locate existing. value is new domain name | |LOCATE |DOMAIN |GLOBAL |DOMAIN_NAME |value||find existing domain by name. value is domain name | ^DOMAIN as scope alias^^^^^^^ |ASSIGN |DOMAIN ||-attribute- |value| |assign the domain attribute a value. replace -attribute- with actual name. | |DELETE |DOMAIN ||COMPLETE | | |delete Domain including custom parameters, networks and os_images. May not have YCE or CMDB nodes | ^DOMAIN alias in other contexts^^^^^^^ |ADD |CMDB ||NODE |||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | |ADD |CMDB ||NODE |value||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | ^DOMAIN object in other contexts^^^^^^^ |ASSIGN |CMDB ||DOMAIN |value| |Assign a Domain to a cmdb-node/node-name. value = Domain | |ASSIGN |CMDB ||DOMAIN |value| |Assign a Domain to a cmdb-node/node-name. value = Domain | |DELETE |DOMAIN |GLOBAL |DOMAIN_NAME |value| |delete Domain including custom parameters, networks and os_images. May not have YCE or CMDB nodes | ===== Client ===== The ''CLIENT'' object uses the alias type '''' ^ CLIENT ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^CLIENT as new alias^^^^^^^ |ADD |CLIENT |CURRENT |CLIENT_CODE |value||create new client of active Client_type. value is new client_code | |LOCATE |CLIENT |CURRENT |CLIENT_CODE |value||find the client in the current client_type with specified client_code. | |LOCATE |CLIENT |CURRENT |CURRENT |value||find the client in the current client_type with specified client_code. | ^CLIENT as scope alias^^^^^^^ |ASSIGN |CLIENT ||-attribute- |value| |set the custom client attibute to the desired value | |ASSIGN |CLIENT ||PAR_GROUP |value| |set the client custom attibute group to the desired value | |DELETE |CLIENT ||COMPLETE | | |delete client including sites, services, nodes, subnets, and topology | ^CLIENT as value alias^^^^^^^ |ASSIGN |SERVER ||CLIENT || |assign the server to any client alias (move server) | ^CLIENT alias in other contexts^^^^^^^ |ADD |SERVER ||SERVER_KEY |value||create server with server_key on client alias | |ADD |SITE ||SITE_CODE |value||create new site for client. value is new site_code | |ADD |SUPERNET ||IP_PLAN |value||add new ip-supernet range to client from pool of free Supernets using numeric ip-plan ID. Or use API custom var "ip_supernet" to specify the supernet | |ADD |SUPERNET ||IP_SUPERNET |value||add new ip-supernet range to client. Format value as "/". Set ip-plan using Assign-Supernet-Ip_plan or use API custom var "ip_plan" | |LOCATE |NODE ||NODE_NAME |value||find a node given its type in the alased client | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position in the alased client | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type in the alased client | |LOCATE |SERVICE ||SERVICE_CLASS |value||find the service in the client-alias with the specified service-class | |LOCATE |SERVICE ||SERVICE_NAME |value||find the service in the client-alias with the specified service-name | |LOCATE |SERVICE ||SERVICE_TYPE |value||find the service in the client-alias with the specified service-type | |LOCATE |SITE ||SITE_CODE |value||Locates the named site of the aliased client | |LOCATE |SUPERNET ||IP_PLAN |value||find the (first) supernet within the client matching the Ip_plan value | |LOCATE |SUPERNET ||IP_SUPERNET |value||find the supernet within the client matching the "
[/]" value | |LOCATE |SERVER ||SERVER_NAME |value||find server with server_name on client alias | |LOCATE |SERVER ||SERVER_KEY |value||find server with server_key on client alias | ===== Site ===== The ''SITE'' object uses the alias type '''' ^ SITE ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SITE as new alias^^^^^^^ |ADD |SITE ||SITE_CODE |value||create new site for client. value is new site_code | |LOCATE |SITE ||SITE_CODE |value||Locates the named site of the aliased client | |LOCATE |SITE |GLOBAL |SITE_CODE |value||Locates the named site globally | ^SITE as scope alias^^^^^^^ |ASSIGN |SITE ||-attribute- |value| |set the custom site attibute to the desired value | |ASSIGN |SITE ||PAR_GROUP |value| |set the site custom attibute group to the desired value | |DELETE |SITE ||COMPLETE | | |delete site including services, nodes, subnets and topology | ^SITE as value alias^^^^^^^ |ASSIGN |SERVER ||SITE || |assign the server to any site alias (move server) | ^SITE alias in other contexts^^^^^^^ |ADD |SERVER ||SERVER_KEY |value||create server with server_key on site alias | |ADD |SERVICE ||CURRENT |value||creates a new service container on current site | |ADD |SERVICE |SITE |SITE_CODE |||creates a new service container on aliased site | |LOCATE |SERVER ||SERVER_NAME |value||find server with server_name on site alias | |LOCATE |NODE ||NODE_NAME |value||find a node given its name on the aliased site | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position on the aliased site | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type on the aliased site | |LOCATE |SERVICE ||SERVICE_CLASS |value||find the service on the site-alias with the specified service-class | |LOCATE |SERVICE ||SERVICE_NAME |value||find the service on the site-alias with the specified service-name | |LOCATE |SERVICE ||SERVICE_TYPE |value||find the service on the site-alias with the specified service-type | |LOCATE |SERVER ||SERVER_KEY |value||find server with server_key on site alias | ===== Service ===== The ''SERVICE'' object uses the alias type '''' ^ SERVICE ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SERVICE as new alias^^^^^^^ |ADD |SERVICE ||CURRENT |value||creates a new service container on current site | |ADD |SERVICE |SITE |CURRENT |value||creates a new service container on current site | |ADD |SERVICE |SITE |SITE_CODE |||creates a new service container on aliased site | |LOCATE |SERVICE |CLIENT |CURRENT | ||find the current selected service (tasks only) | |LOCATE |SERVICE |CLIENT |SERVICE_CLASS |value||find the service in the client with the specified service-class | |LOCATE |SERVICE |CLIENT |SERVICE_NAME |value||find the service in the client with the specified service-name | |LOCATE |SERVICE |CLIENT |SERVICE_TYPE |value||find the service in the client with the specified service-type | |LOCATE |SERVICE ||SERVICE_CLASS |value||find the service in the client-alias with the specified service-class | |LOCATE |SERVICE ||SERVICE_NAME |value||find the service in the client-alias with the specified service-name | |LOCATE |SERVICE ||SERVICE_TYPE |value||find the service in the client-alias with the specified service-type | |LOCATE |SERVICE |GLOBAL |NODE |||find the service the node is part of | |LOCATE |SERVICE |GLOBAL |NODE |value||find the service the node is part of | |LOCATE |SERVICE |GLOBAL |SERVICE_CLASS |value||find the service globally with the specified service-class | |LOCATE |SERVICE |GLOBAL |SERVICE_NAME |value||find the service globally with the specified service-name | |LOCATE |SERVICE |GLOBAL |SERVICE_TYPE |value||find the service globally with the specified service-type | |LOCATE |SERVICE |SERVICE |CURRENT | ||find the current selected service (tasks only) | |LOCATE |SERVICE ||SERVICE_CLASS |value||find the service on the site-alias with the specified service-class | |LOCATE |SERVICE ||SERVICE_NAME |value||find the service on the site-alias with the specified service-name | |LOCATE |SERVICE ||SERVICE_TYPE |value||find the service on the site-alias with the specified service-type | |LOCATE |SERVICE |SITE |SERVICE_CLASS |value||find the service on the site with the specified service-class | |LOCATE |SERVICE |SITE |SERVICE_NAME |value||find the service on the site with the specified service-name | |LOCATE |SERVICE |SITE |SERVICE_TYPE |value||find the service on the site with the specified service-type | ^SERVICE as scope alias^^^^^^^ |ASSIGN |SERVICE ||-attribute- |value| |set the custom service attibute to the desired value | |ASSIGN |SERVICE ||HIERARCHY_ID |value| |set the service hierarchy-id to the desired value | |ASSIGN |SERVICE ||PAR_GROUP |value| |set the service custom attribute group to the desired value | |ASSIGN |SERVICE ||SERVICE_CLASS |value| |set the service class to the desired value | |ASSIGN |SERVICE ||SERVICE_NAME |value| |set the service name to the desired value | |ASSIGN |SERVICE ||SERVICE_TYPE |value| |set the service type to the desired value | |DELETE |SERVICE ||COMPLETE | | |delete service including nodes, subnets and topology | ^SERVICE as value alias^^^^^^^ |ASSIGN |SUBNET ||SERVICE || |re-assign (move) the vlan/subnet to the service indicated | ^SERVICE alias in other contexts^^^^^^^ |ADD |IPV6_NET ||CUSTOM |value||add new CUSTOM Ipv6-subnet. No IP-plan is used. Value is the net_name, the ipv6 address range must be assigned later | |ADD |IPV6_NET ||NET_NAME |value||add an IPV6_NET by name. Value can be "ipv6net_name" or "ipv6_net_name - ipv6_plan_descr" | |ADD |NODE ||NODE_TYPE |value||create new node in a service of specified node-type | |ADD |SUBNET ||CUSTOM |value||add new CUSTOM subnet. No IP-plan is used | |ADD |SUBNET ||NET_NAME |value||locate and add subnet from an IP-plan by name | |ADD |SUBNET ||NET_NAME_ \\ NOTFULL |value||locate and conditionally add subnet from an IP-plan by name should the existing be 'full' | |ADD |SUBNET ||NET_NAME_ \\ AT_ADDRESS |value||create an ip-plan based subnet in a service using net-name AND subnet-address. Value format: " " | |ADD |SUBNET ||NET_NAME_ \\ FROM_ADDRESS |value||create an ip-plan based subnet in a service using net-name AND subnet-address. Finds the first free subnet. Value format: " " | |ADD |SUBNET ||FIRSTFREE_ \\ FROM_SUBNET |||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet | |ADD |SUBNET ||FIRSTFREE_ \\ SUBNET_OFFSET | ||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet starting from the provided offset | |LOCATE |IPV6_NET ||NET_ADDRESS |value||find the IPV6_NET in the service using its Ipv6 network-address. Use the optional prefix to normalize the network-address: / | |LOCATE |IPV6_NET ||VLAN_ID |value||find the IPV6_NET in the service using its Vlan_id. The subnet with the fewest assigned ports is selected. | |LOCATE |IPV6_NET ||NET_DESCR |value||find the IPV6_NET in the service using its Net_description or Net_name. The subnet with the fewest assigned ports is selected. | |LOCATE |IPV6_NET ||NET_NAME |value||find the IPV6_NET in the service using its Net_name. The subnet with the fewest assigned ports is selected. | |LOCATE |NODE ||NODE_NAME |value||find a node given its type in its service | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position in its service | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type in its service | |LOCATE |SUBNET ||NET_ADDRESS |value||find the subnet in the service by network-address. Value may include the /prefix | |LOCATE |SUBNET ||NET_DESCR |value||locate subnet by description in service | |LOCATE |SUBNET ||NET_NAME |value||locate subnet by name *or* description in service | |LOCATE |SUBNET ||NET_NAME_ \\ NOTFULL |value||find and conditionally add subnet from an IP-plan by name should the existing be 'full' | |LOCATE |SUBNET ||VLAN_ID |value||find the subnet by vlan-id in the service | |LOCATE |IPV6_NET ||IPV6_NET |value||find the IPV6_NET in the service using Net_name and Ipv6-plan. Type_value uses the format: - | ===== Node ===== The ''NODE'' object uses the alias type '''' ^ NODE ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^NODE as new alias^^^^^^^ |ADD |NODE ||NODE_TYPE |value||create new node in a service of specified node-type | |LOCATE |NODE |CLIENT |NODE_NAME |value||find a node given its type in the client | |LOCATE |NODE |CLIENT |NODE_POSITION |value||find a node given its position in the client | |LOCATE |NODE |CLIENT |NODE_TYPE |value||find a node given its type in the client | |LOCATE |NODE ||NODE_NAME |value||find a node given its type in the alased client | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position in the alased client | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type in the alased client | |LOCATE |NODE |GLOBAL |NODE_NAME |value||find node using its name. Supports wildcard | |LOCATE |NODE ||DOWNLINK_NODE |||finds the downlink node relative to the "node" using the topology of the interfaces in "1portlist" | |LOCATE |NODE ||DOWNLINK_NODE |value||finds the downlink node relative to the "node" using the topology of the interfaces in "2portlist" | |LOCATE |NODE ||PEERLINK_NODE |||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||PEERLINK_NODE |value||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |value||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE |SERVICE |CURRENT | ||find the selected node in the current service (front-end non-"create" tasks only) | |LOCATE |NODE ||NODE_NAME |value||find a node given its name on the aliased site | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position on the aliased site | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type on the aliased site | |LOCATE |NODE |SITE |NODE_NAME |value||find a node given its name on the site | |LOCATE |NODE |SITE |NODE_POSITION |value||find a node given its position on the site | |LOCATE |NODE |SITE |NODE_TYPE |value||find a node given its type on the site | |LOCATE |NODE ||NODE_NAME |value||find a node given its type in its service | |LOCATE |NODE ||NODE_POSITION |value||find a node given its position in its service | |LOCATE |NODE ||NODE_TYPE |value||find a node given its type in its service | ^NODE as scope alias^^^^^^^ |LOCATE |LINK ||NODE |||find the ports involved linking these two nodes | |ASSIGN |NODE ||-attribute- |value| |set the custom node attribute to the desired value | |ASSIGN |NODE ||IPSEC_TUNNEL |value| |assign node to pre-existing ipsec tunnel-id | |ASSIGN |NODE ||NODE_NAME |value| |rename existing node to specified name | |ASSIGN |NODE ||NODE_POSITION |value| |assign a node to a position in the reference-model | |ASSIGN |NODE ||PAR_GROUP |value| |set the node custom attribute group to the desired value | |ASSIGN |NODE ||REDUNDANT |value| |rename existing node to specified name | |ASSIGN |NODE ||TEMPLATE |value| |change Template and ports. Keeps obsolete topo/subnets, keeps port-details | |ASSIGN |NODE ||TEMPLATE_ \\ FORCE |value| |change Template and ports. Drops obsolete topo/subnets, updates port-details | |ASSIGN |NODE ||VRF || |make node a member of the MPLS vrf specified | |DELETE |NODE ||COMPLETE | | |delete node including topology | |DELETE |NODE ||VRF || |remove node from vrf | ^NODE as value alias^^^^^^^ |ADD |CMDB ||NODE |||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | |LOCATE |LINK ||NODE |||find the ports involved linking these two nodes | |LOCATE |NODE ||DOWNLINK_NODE |||finds the downlink node relative to the "node" using the topology of the interfaces in "1portlist" | |LOCATE |NODE ||PEERLINK_NODE |||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |PORT ||NODE |||find first port in list matching the node | |LOCATE |PORTS ||NODE |||find ports in list matching the node | |LOCATE |SERVICE |GLOBAL |NODE |||find the service the node is part of | |LOCATE |CMDB |CMDB |NODE |||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | |ASSIGN |VRF ||NODE || |make node a member of the MPLS vrf specified | |DELETE |VRF ||NODE || |remove node from vrf | |DELETE |CMDB |CMDB |NODE || |Delete a node from the CMDB by node name. value = node-alias, nodename or fqdn | ^NODE alias in other contexts^^^^^^^ |ADD |PORT ||ATM |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||FAST_ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||FOURTYGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||GIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||HUNDREDGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||LOOPBACK |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||MANAGEMENT |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||PORT_CHANNEL |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||PORT_CHANNEL_ \\ NEW |value||value = lowest portchannel-id number to start search for new id | |ADD |PORT ||SERIAL |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||TENGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||TYPE_FROM_ \\ NAME |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||ATM |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FAST_ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||GIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||SERIAL |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TYPE_FROM_ \\ NAME |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |VRF ||VRF_ID |value||create vrf on node using its id. Note: node must have management / loopback address assigned first! | |ADD |VRF ||VRF_NAME |value||create vrf on node using its name. Note: node must have management / loopback address assigned first! | |ADD |VRF ||MPLS_VRF |mpls_vrf ||create vrf on node using a Mpls_vrf alias. Note: node must have management / loopback address assigned first! | |LOCATE |LINK ||PORT_TEMPLATE |value||find the ports involved in a link using a local port-template | |LOCATE |VRF ||VRF_NAME |value||find a vrf on the node using its name | |LOCATE |PORT ||PORT_NAME |value||find first port of a node matching the (wildcard) port-name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORT ||PORT_TEMPLATE |value||find first port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port without topology using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTSHUT |value||find first disabled port with this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find first port without topology using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTSHUT |value||find last disabled port with this template. Wildcard optional | |LOCATE |PORTS ||ATM |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FAST_ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||GIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||LOOPBACK |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||MANAGEMENT |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_CHANNEL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all ports in list with this template | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALLNOTOPO |value||find all ports in list with this template without topology | |LOCATE |PORTS ||SERIAL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |SLOT ||SLOT_ID |value||find all interfaces using slot_id. Value format = slot[/module]. You can use '/' to indicate blank slot/module | |LOCATE |VRF ||VRF_ID |value||find a vrf on the node using its id | |LOCATE |ADDRESS ||MANAGEMENT | ||Returns the management ip-address for the as an alias | |LOCATE |PORTS ||PORT_NAME |value||find all ports of a node matching the (wildcard) port-name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||-attribute- |value||find all ports of a node matching the (wildcard) attribute value | |LOCATE |PORT ||-attribute- |value||find first port of a node matching the (wildcard) attribute value | |ASSIGN |EVPN_VLAN ||EVPN_CORE || |assign eVPN to a core-node by node-alias | |ASSIGN |EVPN_VLAN ||EVPN_CORE |value| |assign eVPN to a core-node by name | |ASSIGN |CMDB ||VENDOR |value| |Assign a Vendor to a cmdb-alias/node-name. value = Vendor_type name | |ASSIGN |CMDB ||FQDN |value| |Assign a fqdn (NodeName) to a cmdb-node/node-name. value = fqdn or ip-address | |ASSIGN |CMDB ||DOMAIN |value| |Assign a Domain to a cmdb-node/node-name. value = Domain | |ASSIGN |CMDB ||-attribute- |value| |Assign a value to any attribute of a cmdb-node/node-name. Replace -attribute for attribute name. value = attribute value | |DELETE |SLOT ||SLOT_ID |value| |remove ports based on slot-id, delete any attached topology | ^NODE object in other contexts^^^^^^^ |ADD |CMDB ||NODE |value||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | |LOCATE |SERVICE |GLOBAL |NODE |value||find the service the node is part of | |LOCATE |CMDB |CMDB |NODE |value||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | |DELETE |CMDB |CMDB |NODE |value| |Delete a node from the CMDB by node name. value = node-alias, nodename or fqdn | ===== Port ===== The ''PORT'' object uses the alias type '''' ^ PORT ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^PORT as new alias^^^^^^^ |ADD |PORT ||ATM |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||FAST_ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||FOURTYGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||GIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||HUNDREDGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||LOOPBACK |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||MANAGEMENT |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||PORT_CHANNEL |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||PORT_CHANNEL_ \\ NEW |value||value = lowest portchannel-id number to start search for new id | |ADD |PORT ||SERIAL |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||TENGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORT ||TYPE_FROM_ \\ NAME |value||value Interface-name: [type][slot/][module/]port. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |LOCATE |PORT ||PORT_NAME |value||find first port of a node matching the (wildcard) port-name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORT ||PORT_TEMPLATE |value||find first port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port without topology using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTSHUT |value||find first disabled port with this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find first port without topology using this template. Wildcard optional | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTSHUT |value||find last disabled port with this template. Wildcard optional | |LOCATE |PORT ||AT_SUBNET |||Locate the given port if assigned to the given subnet. Port and subnet are aliases | |LOCATE |PORT ||NODE |||find first port in list matching the node | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find last port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find last port in list with this template without topology | |LOCATE |PORT ||AT_IPV6_NET |||Locate the given port if assigned to the given Ipv6 subnet. Port and Ipv6 subnet are aliases | |LOCATE |PORT ||PORT_NAME |value||find first port within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORT ||-attribute- |value||find first port of a node matching the (wildcard) attribute value | |LOCATE |PORT ||-attribute- |value||find first port within a portlist matching the (wildcard) attrbute value | ^PORT as scope alias^^^^^^^ |ADD |LINK ||PORT |||connect two ports using topology | |LOCATE |PORT ||AT_SUBNET |||Locate the given port if assigned to the given subnet. Port and subnet are aliases | |LOCATE |PORT ||AT_IPV6_NET |||Locate the given port if assigned to the given Ipv6 subnet. Port and Ipv6 subnet are aliases | |ASSIGN |PORT ||-attribute- |value| |assign port attribute a value. replace -attribute- with actual name. | |ASSIGN |PORT ||PORT_CHANNEL |value| |make the port a port-channel member of specified channel-id | |ASSIGN |PORT ||PORT_CHANNEL_ \\ OF || |make the port a member of the channel-group of the other port | |ASSIGN |PORT ||PORT_DESCR |value| |update the port_description. Defaults to template-description | |ASSIGN |PORT ||PORT_MODE |value| |set the duplex mode of the port | |ASSIGN |PORT ||PORT_NAME_OF || |move the port to the other port's location. Drops the target port along with topo/subs | |ASSIGN |PORT ||PORT_SHUT |value| |enable or disable the port (shut=Y -> disabled) | |ASSIGN |PORT ||PORT_SPEED |value| |set the port speed in Mbps | |ASSIGN |PORT ||PORT_TEMPLATE |value| |set the port's port-template | |ASSIGN |PORT ||PORT_TEMPLATE_ \\ OF || |set the port's port-template to that of the other port | |ASSIGN |PORT ||SUBNET || |make the port a member of the vlan/subnet | |ASSIGN |PORT ||IPV6_NET || |make the port a member of the Ipv6 vlan/subnet | |DELETE |PORT ||COMPLETE | | |delete port including topology | |DELETE |PORT ||SUBNET || |remove subnet from port | |DELETE |PORT ||SUBNET_ALL | | |remove all subnet assignments from aliased port | |DELETE |PORT ||TOPOLOGY | | |remove topology from port | ^PORT as value alias^^^^^^^ |ADD |LINK ||PORT |||connect two ports using topology | |ASSIGN |ADDRESS ||PORT || |set a single IP-address on a Management or Loopback interface | |ASSIGN |IPV6_ADDR ||PORT || |set a single IP-IPV6_ADDR on a Management or Loopback interface | |ASSIGN |IPV6_NET ||PORT || |make the port a member of the Ipv6 vlan/subnet | |ASSIGN |PORT ||PORT_CHANNEL_ \\ OF || |make the port a member of the channel-group of the other port | |ASSIGN |PORT ||PORT_NAME_OF || |move the port to the other port's location. Drops the target port along with topo/subs | |ASSIGN |PORT ||PORT_TEMPLATE_ \\ OF || |set the port's port-template to that of the other port | |ASSIGN |SUBNET ||PORT || |make the port a member of the vlan/subnet | |DELETE |IPV6_NET ||PORT || |remove IPV6_NET from port | |DELETE |SUBNET ||PORT || |remove subnet from port | ^PORT alias in other contexts^^^^^^^ |LOCATE |SUBNET ||AT_PORT |||Locate the given subnet if assigned to the given port. Subnet and port are aliases | |LOCATE |IPV6_NET ||AT_PORT |||Locate the given Ipv6 subnet if assigned to the given port. Ipv6 subnet and port are aliases | |ASSIGN |PORTS ||PORT_CHANNEL_ \\ OF || |make the ports a member of the channel-group of the other port | |ASSIGN |PORTS ||PORT_TEMPLATE_ \\ OF || |set the port port-template to that of the other port | ===== Ports ===== The ''PORTS'' object uses the alias type '''' ^ PORTS ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^PORTS as new alias^^^^^^^ |ADD |PORTS ||ATM |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FAST_ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||GIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||SERIAL |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TYPE_FROM_ \\ NAME |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |LOCATE |PORTS ||ATM |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FAST_ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||GIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||LOOPBACK |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||MANAGEMENT |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_CHANNEL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all ports in list with this template | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALLNOTOPO |value||find all ports in list with this template without topology | |LOCATE |PORTS ||SERIAL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||AT_SUBNET |||Locate ports in the given list if assigned to the given subnet. Ports and subnet are aliases | |LOCATE |PORTS ||NODE |||find ports in list matching the node | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all the ports in list with this template | |LOCATE |PORTS ||AT_IPV6_NET |||Locate ports in the given list if assigned to the given Ipv6 subnet. Ports and Ipv6 subnet are aliases | |LOCATE |PORTS ||PORT_NAME |value||find all ports of a node matching the (wildcard) port-name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||PORT_NAME |value||find ports within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||-attribute- |value||find all ports of a node matching the (wildcard) attribute value | |LOCATE |PORTS ||-attribute- |value||find ports within a portlist matching the (wildcard) attrbute value | ^PORTS as scope alias^^^^^^^ |LOCATE |PORTS ||AT_SUBNET |||Locate ports in the given list if assigned to the given subnet. Ports and subnet are aliases | |LOCATE |PORTS ||NODE |||find ports in list matching the node | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all the ports in list with this template | |LOCATE |PORTS ||AT_IPV6_NET |||Locate ports in the given list if assigned to the given Ipv6 subnet. Ports and Ipv6 subnet are aliases | |LOCATE |PORTS ||PORT_NAME |value||find ports within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||-attribute- |value||find ports within a portlist matching the (wildcard) attrbute value | |ASSIGN |PORTS ||-attribute- |value| |assign port attribute a value. replace -attribute- with actual name. | |ASSIGN |PORTS ||PORT_CHANNEL |value| |make the ports a port-channel member of specified channel-id | |ASSIGN |PORTS ||PORT_CHANNEL_ \\ OF || |make the ports a member of the channel-group of the other port | |ASSIGN |PORTS ||PORT_MODE |value| |set the duplex mode of the ports | |ASSIGN |PORTS ||PORT_SHUT |value| |enable or disable the ports (shut=Y -> disabled) | |ASSIGN |PORTS ||PORT_SPEED |value| |set the ports speed in Mbps | |ASSIGN |PORTS ||PORT_TEMPLATE |value| |set the ports port-template | |ASSIGN |PORTS ||PORT_TEMPLATE_ \\ OF || |set the port port-template to that of the other port | |ASSIGN |PORTS ||SUBNET || |make the ports a member of the vlan/subnet | |ASSIGN |PORTS ||IPV6_NET || |make the ports a member of the Ipv6 vlan/subnet | |DELETE |PORTS ||COMPLETE | | |delete ports including topology | |DELETE |PORTS ||SUBNET || |remove subnet from ports | |DELETE |PORTS ||SUBNET_ALL | | |remove all subnet assignments from aliased ports | |DELETE |PORTS ||TOPOLOGY | | |remove topology from ports | ^PORTS as value alias^^^^^^^ |ASSIGN |IPV6_NET ||PORTS || |make the ports a member of the Ipv6 vlan/subnet | |ASSIGN |SUBNET ||PORTS || |make the ports a member of the vlan/subnet | |DELETE |IPV6_NET ||PORTS || |remove IPV6_NET from ports | |DELETE |SUBNET ||PORTS || |remove subnet from ports | ^PORTS alias in other contexts^^^^^^^ |ADD |LINK ||PORT |||connect two ports using topology | |LOCATE |LINK ||NODE |||find the ports involved linking these two nodes | |LOCATE |LINK ||PORT_TEMPLATE |value||find the ports involved in a link using a local port-template | |LOCATE |NODE ||DOWNLINK_NODE |||finds the downlink node relative to the "node" using the topology of the interfaces in "1portlist" | |LOCATE |NODE ||DOWNLINK_NODE |value||finds the downlink node relative to the "node" using the topology of the interfaces in "2portlist" | |LOCATE |NODE ||PEERLINK_NODE |||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||PEERLINK_NODE |value||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |value||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |PORT ||NODE |||find first port in list matching the node | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find last port in list with this template without topology | |LOCATE |PORT ||PORT_NAME |value||find first port within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORT ||-attribute- |value||find first port within a portlist matching the (wildcard) attrbute value | |ASSIGN |SUBNET ||LINK || |make the ports of the link a member of the vlan/subnet | |ASSIGN |IPV6_NET ||LINK || |make the ports of the link a member of the Ipv6 vlan/subnet | |ASSIGN |LINK ||IPV6_NET || |make the ports of the link a member of the Ipv6 vlan/subnet | ===== Link ===== The ''LINK'' object uses the alias type '''' ^ LINK ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^LINK as new alias^^^^^^^ |ADD |LINK ||PORT |||connect two ports using topology | |LOCATE |LINK ||NODE |||find the ports involved linking these two nodes | |LOCATE |LINK ||PORT_TEMPLATE |value||find the ports involved in a link using a local port-template | ^LINK as scope alias^^^^^^^ |ASSIGN |LINK ||IPV6_NET || |make the ports of the link a member of the Ipv6 vlan/subnet | ^LINK as value alias^^^^^^^ |ASSIGN |SUBNET ||LINK || |make the ports of the link a member of the vlan/subnet | |ASSIGN |IPV6_NET ||LINK || |make the ports of the link a member of the Ipv6 vlan/subnet | ^LINK alias in other contexts^^^^^^^ |ADD |PORTS ||ATM |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FAST_ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||GIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||SERIAL |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |ADD |PORTS ||TYPE_FROM_ \\ NAME |value||value Interface-name: [type][slot/][module/]port[-port]. Type may be vendor interface-name or NetYCE internal Port_class and overrides type in command | |LOCATE |NODE ||DOWNLINK_NODE |||finds the downlink node relative to the "node" using the topology of the interfaces in "1portlist" | |LOCATE |NODE ||DOWNLINK_NODE |value||finds the downlink node relative to the "node" using the topology of the interfaces in "2portlist" | |LOCATE |NODE ||PEERLINK_NODE |||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||PEERLINK_NODE |value||finds the peer/interlink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |NODE ||UPLINK_NODE |value||finds the uplink node relative to the "node" using the topology of the interfaces in "portlist" | |LOCATE |PORT ||NODE |||find first port in list matching the node | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find last port in list with this template without topology | |LOCATE |PORTS ||ATM |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FAST_ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||FOURTYGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||GIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||HUNDREDGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||LOOPBACK |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||MANAGEMENT |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_CHANNEL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all ports in list with this template | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALLNOTOPO |value||find all ports in list with this template without topology | |LOCATE |PORTS ||SERIAL |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||TENGIGABIT_ \\ ETHERNET |value||value format= slot[/module]/port[-port]. Use '*' for any slot, module or port | |LOCATE |PORTS ||AT_SUBNET |||Locate ports in the given list if assigned to the given subnet. Ports and subnet are aliases | |LOCATE |PORTS ||NODE |||find ports in list matching the node | |LOCATE |PORTS ||PORT_TEMPLATE_ \\ ALL |value||find all the ports in list with this template | |LOCATE |PORTS ||AT_IPV6_NET |||Locate ports in the given list if assigned to the given Ipv6 subnet. Ports and Ipv6 subnet are aliases | |LOCATE |PORTS ||PORT_NAME |value||find all ports of a node matching the (wildcard) port-name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||PORT_NAME |value||find ports within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORT ||PORT_NAME |value||find first port within a portlist matching the (wildcard) name. Use internal or vendor name e.g.: Gi01/01/1*, GigabitEthernet/1/1* | |LOCATE |PORTS ||-attribute- |value||find all ports of a node matching the (wildcard) attribute value | |LOCATE |PORTS ||-attribute- |value||find ports within a portlist matching the (wildcard) attrbute value | |LOCATE |PORT ||-attribute- |value||find first port within a portlist matching the (wildcard) attrbute value | |ASSIGN |IPV6_NET ||PORTS || |make the ports a member of the Ipv6 vlan/subnet | |ASSIGN |PORTS ||-attribute- |value| |assign port attribute a value. replace -attribute- with actual name. | |ASSIGN |PORTS ||PORT_CHANNEL |value| |make the ports a port-channel member of specified channel-id | |ASSIGN |PORTS ||PORT_CHANNEL_ \\ OF || |make the ports a member of the channel-group of the other port | |ASSIGN |PORTS ||PORT_MODE |value| |set the duplex mode of the ports | |ASSIGN |PORTS ||PORT_SHUT |value| |enable or disable the ports (shut=Y -> disabled) | |ASSIGN |PORTS ||PORT_SPEED |value| |set the ports speed in Mbps | |ASSIGN |PORTS ||PORT_TEMPLATE |value| |set the ports port-template | |ASSIGN |PORTS ||PORT_TEMPLATE_ \\ OF || |set the port port-template to that of the other port | |ASSIGN |PORTS ||SUBNET || |make the ports a member of the vlan/subnet | |ASSIGN |SUBNET ||PORTS || |make the ports a member of the vlan/subnet | |ASSIGN |PORTS ||IPV6_NET || |make the ports a member of the Ipv6 vlan/subnet | |DELETE |IPV6_NET ||PORTS || |remove IPV6_NET from ports | |DELETE |PORTS ||COMPLETE | | |delete ports including topology | |DELETE |PORTS ||SUBNET || |remove subnet from ports | |DELETE |PORTS ||SUBNET_ALL | | |remove all subnet assignments from aliased ports | |DELETE |PORTS ||TOPOLOGY | | |remove topology from ports | |DELETE |SUBNET ||PORTS || |remove subnet from ports | ===== Slot ===== The ''SLOT'' object uses the alias type '''' ^ SLOT ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SLOT as new alias^^^^^^^ |LOCATE |SLOT ||SLOT_ID |value||find all interfaces using slot_id. Value format = slot[/module]. You can use '/' to indicate blank slot/module | ^SLOT as scope alias^^^^^^^ |ASSIGN |SLOT ||SLOT_ID |value| |Move all interfaces to a new slot_id. Value format = slot[/module]. You can use '/' to indicate blank slot/module | ^SLOT alias in other contexts^^^^^^^ |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRST |value||find first port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ FIRSTNOTOPO |value||find first port in list with this template without topology | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LAST |value||find last port in list with this template | |LOCATE |PORT ||PORT_TEMPLATE_ \\ LASTNOTOPO |value||find last port in list with this template without topology | ^SLOT object in other contexts^^^^^^^ |DELETE |SLOT ||SLOT_ID |value| |remove ports based on slot-id, delete any attached topology | ===== Server ===== The ''SERVER'' object uses the alias type '''' ^ SERVER ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SERVER as new alias^^^^^^^ |ADD |SERVER ||SERVER_KEY |value||create server with server_key on client alias | |ADD |SERVER ||SERVER_KEY |value||create server with server_key on site alias | |LOCATE |SERVER ||SERVER_NAME |value||find server with server_name on site alias | |LOCATE |SERVER ||SERVER_KEY |value||find server with server_key on site alias | |LOCATE |SERVER ||SERVER_NAME |value||find server with server_name on client alias | |LOCATE |SERVER ||SERVER_KEY |value||find server with server_key on client alias | ^SERVER as scope alias^^^^^^^ |ASSIGN |SERVER ||SERVER_NAME |value| |set the server hostname to value | |ASSIGN |SERVER ||SERVER_STATUS |value| |set the server status to value (numeric) | |ASSIGN |SERVER ||SERVER_NOTES |value| |set the server description to value | |ASSIGN |SERVER ||CLIENT || |assign the server to any client alias (move server) | |ASSIGN |SERVER ||SITE || |assign the server to any site alias (move server) | |ASSIGN |SERVER ||SERVER_ \\ ADDRESS |value| |set the server ipv4-address to value | |ASSIGN |SERVER ||SERVER_ \\ IPV6_ADDR |value| |set the server ipv6-address to value | |DELETE |SERVER ||COMPLETE | | |remove the server | ===== Supernet ===== The ''SUPERNET'' object uses the alias type '''' ^ SUPERNET ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SUPERNET as new alias^^^^^^^ |ADD |SUPERNET ||IP_PLAN |value||add new ip-supernet range to client from pool of free Supernets using numeric ip-plan ID. Or use API custom var "ip_supernet" to specify the supernet | |ADD |SUPERNET ||IP_SUPERNET |value||add new ip-supernet range to client. Format value as "/". Set ip-plan using Assign-Supernet-Ip_plan or use API custom var "ip_plan" | |LOCATE |SUPERNET ||IP_PLAN |value||find the (first) supernet within the client matching the Ip_plan value | |LOCATE |SUPERNET ||IP_SUPERNET |value||find the supernet within the client matching the "
[/]" value | ^SUPERNET as scope alias^^^^^^^ |ASSIGN |SUPERNET ||DNS_DOMAIN |value| |assign the value to the supernet Dns_domain attribute | |ASSIGN |SUPERNET ||IP_PLAN |value| |assign the numeric ip-plan ID to the supernet-alias. Supernet and plan prefixes must match. Cannot change a supernet plan-id which has active subnets | |ASSIGN |SUPERNET ||SITE_CODE |value| |assign the value to the Supernet SiteCode attribute. SiteCode must exist in Client | |DELETE |SUPERNET ||COMPLETE | | |remove the supernet from the client after DELETING all its subnets. Place supernet in free pool | |DELETE |SUPERNET ||FREE | | |remove the supernet from the client IF there are no subnets left. Place supernet in free pool | ===== Subnet ===== The ''SUBNET'' object uses the alias type '''' ^ SUBNET ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^SUBNET as new alias^^^^^^^ |ADD |SUBNET ||CUSTOM |value||add new CUSTOM subnet. No IP-plan is used | |ADD |SUBNET ||NET_NAME |value||locate and add subnet from an IP-plan by name | |ADD |SUBNET ||NET_NAME_ \\ NOTFULL |value||locate and conditionally add subnet from an IP-plan by name should the existing be 'full' | |ADD |SUBNET ||NET_NAME_ \\ AT_ADDRESS |value||create an ip-plan based subnet in a service using net-name AND subnet-address. Value format: " " | |ADD |SUBNET ||NET_NAME_ \\ FROM_ADDRESS |value||create an ip-plan based subnet in a service using net-name AND subnet-address. Finds the first free subnet. Value format: " " | |ADD |SUBNET ||FIRSTFREE_ \\ FROM_SUBNET |||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet | |ADD |SUBNET ||FIRSTFREE_ \\ SUBNET_OFFSET | ||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet starting from the provided offset | |LOCATE |SUBNET ||AT_PORT |||Locate the given subnet if assigned to the given port. Subnet and port are aliases | |LOCATE |SUBNET |SERVICE |CURRENT | ||find the current selected subnet in the service (tasks only) | |LOCATE |SUBNET ||NET_ADDRESS |value||find the subnet in the service by network-address. Value may include the /prefix | |LOCATE |SUBNET ||NET_DESCR |value||locate subnet by description in service | |LOCATE |SUBNET ||NET_NAME |value||locate subnet by name *or* description in service | |LOCATE |SUBNET ||NET_NAME_ \\ NOTFULL |value||find and conditionally add subnet from an IP-plan by name should the existing be 'full' | |LOCATE |SUBNET ||VLAN_ID |value||find the subnet by vlan-id in the service | ^SUBNET as scope alias^^^^^^^ |LOCATE |SUBNET ||AT_PORT |||Locate the given subnet if assigned to the given port. Subnet and port are aliases | |ASSIGN |SUBNET ||-attribute- |value| |assign the subnet attribute a value. replace -attribute- with actual name. | |ASSIGN |SUBNET ||ADDR_RESERVATI \\ ON |value| |set the subnets address reservation count to value | |ASSIGN |SUBNET ||ADDR_RESERVATION_ \\ DEC |value| |decrease the subnets address reservation count to value | |ASSIGN |SUBNET ||ADDR_RESERVATION_ \\ INC |value| |increase the subnets address reservation count to value | |ASSIGN |SUBNET ||LINK || |make the ports of the link a member of the vlan/subnet | |ASSIGN |SUBNET ||MULTICAST |value| |set multicast true/false for the subnet | |ASSIGN |SUBNET ||NET_DESCR |value| |assign this description to the subnet | |ASSIGN |SUBNET ||PORT || |make the port a member of the vlan/subnet | |ASSIGN |SUBNET ||PORTS || |make the ports a member of the vlan/subnet | |ASSIGN |SUBNET ||SERVICE || |re-assign (move) the vlan/subnet to the service indicated | |ASSIGN |SUBNET ||VLAN_ID |value| |assign this vlan-id to the subnet | |ASSIGN |SUBNET ||VLAN_ID_ \\ INCLIENT |value| |find and assign the first free vlan-id in client starting at type-value | |ASSIGN |SUBNET ||VLAN_ID_ \\ INSERVICE |value| |find and assign the first free vlan-id in the service starting at type-value | |ASSIGN |SUBNET ||VLAN_ID_ \\ INSITE |value| |find and assign the first free vlan-id in site starting at type-value | |ASSIGN |SUBNET ||VLAN_TEMPLATE |value| |Assigns the subnet a (layer3) Vlan-template | |ASSIGN |SUBNET ||VRF || |make the vlan/subnet a member of the VRF | |DELETE |SUBNET ||COMPLETE | | |delete subnet, remove from all ports | |DELETE |SUBNET ||PORT || |remove subnet from port | |DELETE |SUBNET ||PORTS || |remove subnet from ports | |DELETE |SUBNET ||VRF || |remove subnet from vrf | ^SUBNET as value alias^^^^^^^ |ADD |SUBNET ||FIRSTFREE_ \\ FROM_SUBNET |||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet | |ADD |SUBNET ||FIRSTFREE_ \\ SUBNET_OFFSET | ||create an ip-plan based subnet using existing subnet-alias. Finds the first free subnet starting from the provided offset | |ASSIGN |PORT ||SUBNET || |make the port a member of the vlan/subnet | |ASSIGN |PORTS ||SUBNET || |make the ports a member of the vlan/subnet | |ASSIGN |VRF ||SUBNET || |make the vlan/subnet a member of the VRF | |DELETE |PORT ||SUBNET || |remove subnet from port | |DELETE |PORTS ||SUBNET || |remove subnet from ports | |DELETE |VRF ||SUBNET || |remove subnet from vrf | ^SUBNET alias in other contexts^^^^^^^ |ADD |DHCP ||TYPE |value||create a dhcp data-set for a subnet. Type can be off / relay / scope / dual | |LOCATE |ADDRESS ||ADDRESS_ \\ FIRSTFREE |value||find the first free address in a named range of a subnet | |LOCATE |ADDRESS ||ADDRESS_ \\ FIRSTFREE |value| |find the first free address in a named range of a subnet starting from an offset | |LOCATE |ADDRESS ||ADDRESS_ \\ LASTFREE |value||find the last free address in a named range of a subnet | |LOCATE |ADDRESS ||PICK |value||Select specific address in the subnet if free. Value may be offset or absolute. Negative offsets allowed | |LOCATE |ADDRESS ||PICK_FORCED |value||Select specific address in the subnet. Value may be offset or absolute. Negative offsets allowed | |LOCATE |DHCP ||CURRENT | ||find the dhcp data-set for the subnet | |LOCATE |PORT ||AT_SUBNET |||Locate the given port if assigned to the given subnet. Port and subnet are aliases | |LOCATE |PORTS ||AT_SUBNET |||Locate ports in the given list if assigned to the given subnet. Ports and subnet are aliases | |ASSIGN |IPV6_NET ||VLAN_ID_OF || |assign the VLAN_ID of the IPV4-net to the IPV6_NET | ===== Dhcp ===== The ''DHCP'' object uses the alias type '''' ^ DHCP ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^DHCP as new alias^^^^^^^ |ADD |DHCP ||TYPE |value||create a dhcp data-set for a subnet. Type can be off / relay / scope / dual | |LOCATE |DHCP ||CURRENT | ||find the dhcp data-set for the subnet | ^DHCP as scope alias^^^^^^^ |ASSIGN |DHCP ||DHCP_DOMAIN |value| |define the Dhcp domain name option value | |ASSIGN |DHCP ||DNS_SERVERS |value| |define the Dns-servers option value. Enter a list of ip-addresses | |ASSIGN |DHCP ||LEASE_TIME |value| |define the Lease-time option value. Normally in minutes | |ASSIGN |DHCP ||NTP_SERVERS |value| |define the Ntp-servers option value. Enter a list of ip-addresses | |ASSIGN |DHCP ||OPTION1 |value| |define the spare option1 value. | |ASSIGN |DHCP ||OPTION2 |value| |define the spare option2 value. | |ASSIGN |DHCP ||RELAY_GROUP |value| |define the Dhcp-relay-group option value. | |ASSIGN |DHCP ||RELAY_SERVERS |value| |define the Dhcp-relay-servers option value. Enter a list of ip-addresses | |ASSIGN |DHCP ||SCOPE |value| |specify scope-start and scope-end as ip-offsets (0.0.0.50) or numeric-offsets. Scope-end is optional. Separate using space, comma or ' - ' | |ASSIGN |DHCP ||SCOPE_ \\ EXCLUDED |value| |list of ip-ddresses in the scope to exclude. Separate using space, comma or ' - ' | |ASSIGN |DHCP ||TFTP_SERVERS |value| |define the Tftp-servers option value. Enter a list of ip-addresses | |ASSIGN |DHCP ||TYPE |value| |type can be off / relay / scope / dual | |ASSIGN |DHCP ||WINS_SERVERS |value| |define the Wins-servers option value. Enter a list of ip-addresses | |DELETE |DHCP ||COMPLETE | | |remove the Dhcp data-set from the subnet | ===== Address ===== The ''ADDRESS'' object uses the alias type '''' ^ ADDRESS ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^ADDRESS as new alias^^^^^^^ |LOCATE |ADDRESS ||ADDRESS_ \\ FIRSTFREE |value||find the first free address in a named range of a subnet | |LOCATE |ADDRESS ||ADDRESS_ \\ FIRSTFREE |value| |find the first free address in a named range of a subnet starting from an offset | |LOCATE |ADDRESS ||ADDRESS_ \\ LASTFREE |value||find the last free address in a named range of a subnet | |LOCATE |ADDRESS ||PICK |value||Select specific address in the subnet if free. Value may be offset or absolute. Negative offsets allowed | |LOCATE |ADDRESS ||PICK_FORCED |value||Select specific address in the subnet. Value may be offset or absolute. Negative offsets allowed | |LOCATE |ADDRESS ||MANAGEMENT | ||Returns the management ip-address for the as an alias | ^ADDRESS as scope alias^^^^^^^ |ASSIGN |ADDRESS ||PORT || |set a single IP-address on a Management or Loopback interface | ===== Ipv6_net ===== The ''IPV6_NET'' object uses the alias type '''' ^ IPV6_NET ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^IPV6_NET as new alias^^^^^^^ |ADD |IPV6_NET ||CUSTOM |value||add new CUSTOM Ipv6-subnet. No IP-plan is used. Value is the net_name, the ipv6 address range must be assigned later | |ADD |IPV6_NET ||NET_NAME |value||add an IPV6_NET by name. Value can be "ipv6net_name" or "ipv6_net_name - ipv6_plan_descr" | |LOCATE |IPV6_NET ||NET_ADDRESS |value||find the IPV6_NET in the service using its Ipv6 network-address. Use the optional prefix to normalize the network-address: / | |LOCATE |IPV6_NET ||VLAN_ID |value||find the IPV6_NET in the service using its Vlan_id. The subnet with the fewest assigned ports is selected. | |LOCATE |IPV6_NET ||NET_DESCR |value||find the IPV6_NET in the service using its Net_description or Net_name. The subnet with the fewest assigned ports is selected. | |LOCATE |IPV6_NET ||NET_NAME |value||find the IPV6_NET in the service using its Net_name. The subnet with the fewest assigned ports is selected. | |LOCATE |IPV6_NET |SERVICE |CURRENT | ||find the current selected IPV6_NET in the service (GUI tasks only) | |LOCATE |IPV6_NET ||IPV6_NET |value||find the IPV6_NET in the service using Net_name and Ipv6-plan. Type_value uses the format: - | |LOCATE |IPV6_NET ||AT_PORT |||Locate the given Ipv6 subnet if assigned to the given port. Ipv6 subnet and port are aliases | ^IPV6_NET as scope alias^^^^^^^ |LOCATE |IPV6_NET ||AT_PORT |||Locate the given Ipv6 subnet if assigned to the given port. Ipv6 subnet and port are aliases | |ASSIGN |IPV6_NET ||PORTS || |make the ports a member of the Ipv6 vlan/subnet | |ASSIGN |IPV6_NET ||NET_DESCR |value| |change the Ipv6 subnet description to "value". Value defaults to Ipv6_subnet_name | |ASSIGN |IPV6_NET ||NET_DESCR_OF || |change the Ipv6 subnet description to the description found in subnet-alias of value | |ASSIGN |IPV6_NET ||PORT || |make the port a member of the Ipv6 vlan/subnet | |ASSIGN |IPV6_NET ||VLAN_ID_OF || |assign the VLAN_ID of the IPV4-net to the IPV6_NET | |ASSIGN |IPV6_NET ||VLAN_ID |value| |assign this vlan-id to the IPV6_NET | |ASSIGN |IPV6_NET ||VLAN_ID_ \\ INCLIENT |value| |find and assign the first free vlan-id in client starting at type-value | |ASSIGN |IPV6_NET ||VLAN_ID_ \\ INSERVICE |value| |find and assign the first free vlan-id in the service starting at type-value | |ASSIGN |IPV6_NET ||VLAN_ID_ \\ INSITE |value| |find and assign the first free vlan-id in site starting at type-value | |ASSIGN |IPV6_NET ||VLAN_TEMPLATE |value| |Assigns the IPV6_NET a (layer3) Vlan-template | |ASSIGN |IPV6_NET ||VRF || | | |ASSIGN |IPV6_NET ||-attribute- |value| |assign an Ipv6 subnet attribute a value. replace -attribute- with actual name. | |ASSIGN |IPV6_NET ||LINK || |make the ports of the link a member of the Ipv6 vlan/subnet | |DELETE |IPV6_NET ||COMPLETE | | |delete IPV6_NET, remove from all ports | |DELETE |IPV6_NET ||PORT || |remove IPV6_NET from port | |DELETE |IPV6_NET ||PORTS || |remove IPV6_NET from ports | |DELETE |IPV6_NET ||VRF || |remove IPV6_NET from vrf | ^IPV6_NET as value alias^^^^^^^ |ASSIGN |IPV6_NET ||NET_DESCR_OF || |change the Ipv6 subnet description to the description found in subnet-alias of value | |ASSIGN |PORT ||IPV6_NET || |make the port a member of the Ipv6 vlan/subnet | |ASSIGN |PORTS ||IPV6_NET || |make the ports a member of the Ipv6 vlan/subnet | |ASSIGN |LINK ||IPV6_NET || |make the ports of the link a member of the Ipv6 vlan/subnet | ^IPV6_NET alias in other contexts^^^^^^^ |LOCATE |IPV6_ADDR ||IPV6_ADDR_ \\ FIRSTFREE |value||find the first free IPV6_ADDR in a named range of a IPV6_NET | |LOCATE |IPV6_ADDR ||IPV6_ADDR_ \\ LASTFREE |value||find the last free IPV6_ADDR in a named range of a IPV6_NET | |LOCATE |IPV6_ADDR ||RANDOM |value||find the first free IPV6_ADDR in a named range of a IPV6_NET | |LOCATE |PORT ||AT_IPV6_NET |||Locate the given port if assigned to the given Ipv6 subnet. Port and Ipv6 subnet are aliases | |LOCATE |PORTS ||AT_IPV6_NET |||Locate ports in the given list if assigned to the given Ipv6 subnet. Ports and Ipv6 subnet are aliases | ===== Ipv6_addr ===== The ''IPV6_ADDR'' object uses the alias type '''' ^ IPV6_ADDR ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^IPV6_ADDR as new alias^^^^^^^ |LOCATE |IPV6_ADDR ||IPV6_ADDR_ \\ FIRSTFREE |value||find the first free IPV6_ADDR in a named range of a IPV6_NET | |LOCATE |IPV6_ADDR ||IPV6_ADDR_ \\ LASTFREE |value||find the last free IPV6_ADDR in a named range of a IPV6_NET | |LOCATE |IPV6_ADDR ||RANDOM |value||find the first free IPV6_ADDR in a named range of a IPV6_NET | ^IPV6_ADDR as scope alias^^^^^^^ |ASSIGN |IPV6_ADDR ||PORT || |set a single IP-IPV6_ADDR on a Management or Loopback interface | ===== Mpls_vrf ===== The ''MPLS_VRF'' object uses the alias type '''' ^ MPLS_VRF ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^MPLS_VRF as new alias^^^^^^^ |ADD |MPLS_VRF |CURRENT |VRF_ID |value|mpls_vrf |create or locate new mpls-vrf for this client_type. value is new vrf_id | |ADD |MPLS_VRF |CURRENT |VRF_NAME |value|mpls_vrf |create or locate new mpls-vrf for this client_type. value is new vrf_name | |ADD |MPLS_VRF |GLOBAL |VRF_ID_NEW |value|mpls_vrf |create new mpls-vrf for this client_type. value is lowest vrf-id to start search for new id | |LOCATE |MPLS_VRF |CURRENT |VRF_NAME |value|mpls_vrf |locate mpls-vrf for this client_type. value is new vrf_name | |LOCATE |MPLS_VRF |CURRENT |VRF_ID |value|mpls_vrf |locate mpls-vrf for this client_type. value is new vrf_id | ^MPLS_VRF as scope alias^^^^^^^ |ASSIGN |MPLS_VRF |mpls_vrf |-attribute- |value| |set the mpls-vrf attribute to the desired value | |DELETE |MPLS_VRF |mpls_vrf |COMPLETE | | |delete mpls_vrf including its node assignments | ^MPLS_VRF as value alias^^^^^^^ |ADD |VRF ||MPLS_VRF |mpls_vrf ||create vrf on node using a Mpls_vrf alias. Note: node must have management / loopback address assigned first! | ===== Vrf ===== The ''VRF'' object uses the alias type '''' ^ VRF ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^VRF as new alias^^^^^^^ |ADD |VRF ||VRF_ID |value||create vrf on node using its id. Note: node must have management / loopback address assigned first! | |ADD |VRF ||VRF_NAME |value||create vrf on node using its name. Note: node must have management / loopback address assigned first! | |ADD |VRF ||MPLS_VRF |mpls_vrf ||create vrf on node using a Mpls_vrf alias. Note: node must have management / loopback address assigned first! | |LOCATE |VRF |SITE |VRF_ID |value||find a vrf on the site using its id | |LOCATE |VRF ||VRF_NAME |value||find a vrf on the node using its name | |LOCATE |VRF ||VRF_ID |value||find a vrf on the node using its id | |LOCATE |VRF |SITE |VRF_NAME |value||find a vrf on the site using its name | ^VRF as scope alias^^^^^^^ |ASSIGN |VRF ||-attribute- |value| |Set the Node_vrf attribute given tin Type_match to the value specified. Vrf_name cannot be changed. | |ASSIGN |VRF ||NODE || |make node a member of the MPLS vrf specified | |ASSIGN |VRF ||SUBNET || |make the vlan/subnet a member of the VRF | |ASSIGN |VRF ||VRF_TEMPLATE |value| |Value is Vrf template name | |DELETE |VRF ||NODE || |remove node from vrf | |DELETE |VRF ||SUBNET || |remove subnet from vrf | ^VRF as value alias^^^^^^^ |ASSIGN |IPV6_NET ||VRF || | | |ASSIGN |NODE ||VRF || |make node a member of the MPLS vrf specified | |ASSIGN |SUBNET ||VRF || |make the vlan/subnet a member of the VRF | |DELETE |IPV6_NET ||VRF || |remove IPV6_NET from vrf | |DELETE |NODE ||VRF || |remove node from vrf | |DELETE |SUBNET ||VRF || |remove subnet from vrf | ===== Cmdb ===== The ''CMDB'' object uses the alias type '''' ^ CMDB ^^^^^^^ | ||||||| ^//exec//^//class//^//scope//^//match//^//value//^//alias//^//description//^ | ||||||| ^CMDB as new alias^^^^^^^ |ADD |CMDB ||NODE |||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | |ADD |CMDB ||NODE |value||Add a node to the CMDB using Domain alias. value = node-alias, nodename or fqdn | |LOCATE |CMDB |CMDB |NODE |value||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | |LOCATE |CMDB |CMDB |NODE |||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | ^CMDB as scope alias^^^^^^^ |LOCATE |CMDB |CMDB |NODE |value||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | |LOCATE |CMDB |CMDB |NODE |||Find a node in the CMDB by node name. value = node-alias, nodename or fqdn | |ASSIGN |CMDB ||VENDOR |value| |Assign a Vendor to a cmdb-alias/node-name. value = Vendor_type name | |ASSIGN |CMDB ||FQDN |value| |Assign a fqdn (NodeName) to a cmdb node alias. value = fqdn or ip-address | |ASSIGN |CMDB ||DOMAIN |value| |Assign a Domain to a cmdb-node/node-name. value = Domain | |ASSIGN |CMDB ||-attribute- |value| |Assign a value to any attribute of a cmdb-node/node-name. Replace -attribute for attribute name. value = attribute value | |DELETE |CMDB |CMDB |NODE || |Delete a node from the CMDB by node name. value = node-alias, nodename or fqdn | |DELETE |CMDB |CMDB |NODE |value| |Delete a node from the CMDB by node name. value = node-alias, nodename or fqdn | ^CMDB object in other contexts^^^^^^^ |ASSIGN |CMDB ||VENDOR |value| |Assign a Vendor to a cmdb-alias/node-name. value = Vendor_type name | |ASSIGN |CMDB ||FQDN |value| |Assign a fqdn (NodeName) to a cmdb-node/node-name. value = fqdn or ip-address | |ASSIGN |CMDB ||DOMAIN |value| |Assign a Domain to a cmdb-node/node-name. value = Domain | |ASSIGN |CMDB ||-attribute- |value| |Assign a value to any attribute of a cmdb-node/node-name. Replace -attribute for attribute name. value = attribute value |