adopt

Adds device adoption rules to the Auto Provisioning Policy

Supported on the following devices:

Syntax

adopt [anyap|ap41ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600]
adopt [anyap|ap41ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] precedence <1-10000> 
[profile|rf-domain]
adopt [anyap|ap410|ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] precedence <1-10000> 
[profile <DEVICE-PROFILE-NAME>|rf-domain <RF-DOMAIN-NAME>] [any|area|cdp-match|dhcp-option|floor|
fqdn|ip|ipv6|lldp-match|mac|model-number|rf-domain|serial-number|vlan]
adopt [anyap|ap410|ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] precedence <1-10000> 
[profile <DEVICE-PROFILE-NAME>|rf-domain <RF-DOMAIN-NAME>] any
adopt [anyap|ap410|ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] precedence <1-10000> 
[profile <DEVICE-PROFILE-NAME>|rf-domain <RF-DOMAIN-NAME>] [area <AREA-NAME>|
cdp-match <LOCATION-SUBSTRING>|dhcp-option <DHCP-OPTION>|floor <FLOOR-NAME>|fqdn <FQDN>|
ip [<START-IP> <END-IP>|<IP/MASK>]|ipv6 [<START-IP> <END-IP>|<IP/MASK>]|lldp-match <LLDP-STRING>|
mac <START-MAC> {<END-MAC>}|model-number <MODEL-NUMBER>|serial-number <SERIAL-NUMBER>|
rf-domain <RF-DOMAIN-NAME>|vlan <VLAN-ID>]

Parameter

adopt [anyap|ap410|ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] precedence <1-10000> 
[profile <DEVICE-PROFILE-NAME>|rf-domain <RF-DOMAIN-NAME>] any

adopt

 Adds an adopt device rule. The rule applies to the selected device types. Specify the device type and assign a precedence to the rule.

The different device types are:

AP410, AP460. AP505, AP510, AP560, NX5500, NX7500, NX9500, NX9600, and VX9000.

Note: Use the ‘anyap‘ option to auto provision any AP regardless of its model type.

precedence <1-10000>

Sets the rule precedence from 1 - 10000. A rule with a lower value has a higher precedence.

profile <DEVICE-PROFILE- NAME>

Sets the device profile for this provisioning policy. The selected device profile must be appropriate for the device being provisioned. For example, use an AP505 device profile for an AP505. Using an inappropriate device profile can result in unpredictable results. Provide a device profile name.

Provide a device profile name (should be existing and configured). Or a template with appropriate substitution tokens, such as 'campus-$MODEL[1:6]', 'FQDN[1:4]-indoor'. Refer to Usage Guidelines: Built-in Tokens & Alias for the different types of built in tokens available in the system.

rf-domain <RF-DOMAIN-NAME>

Sets the RF Domain for this auto provisioning policy. The provisioning policy is only applicable to devices that try to become a part of the specified RF Domain. Provide the full RF Domain name OR use a string alias to identify the RF Domain.

Provide the full RF Domain name or an alias (should be existing and configured). Or a template with appropriate substitution tokens, such as '$CDP[1:7]', '$DNS-SUFFIX[1:5]'.

Use the built-in string alias or a user-defined string alias. String aliases allow you to configure APs in the same RF Domain as the adopting controller. A string alias maps a name to an arbitrary string value, for example, ‘alias string $DOMAIN test.example_company.com‘. In this example, the string-alias $DOMAIN is mapped to the string: test.example_company.com.

any

Indicates any device. Any device seeking adoption is adopted.

 
adopt [anyap|ap410|ap460|ap505|ap510|ap560|nx5500|nx75xx|nx9000|vx9000|nx9600] 
precedence <1-10000> [profile <DEVICE-PROFILE-NAME>|rf-domain <RF-DOMAIN-NAME>] 
[area <AREA-NAME>|cdp-match <LOCATION-SUBSTRING>|dhcp-option <DHCP-OPTION>|floor <FLOOR-NAME>|
fqdn <FQDN>|ip [<START-IP> <END-IP>|<IP/MASK>]|ipv6 [<START-IP> <END-IP>|<IP/MASK>]|
lldp-match <LLDP-STRING>|mac <START-MAC> {<END-MAC>}|model-number <MODEL-NUMBER>|
serial-number <SERIAL-NUMBER>|rf-domain <RF-DOMAIN-NAME>|vlan <VLAN-ID>]

adopt

 Adds an adopt device rule. The rule applies to the selected device types. Specify the device type and assign a precedence to the rule.

The different device types are:

AP410, AP460. AP505, AP510, AP560, NX5500, NX7500, NX9500, NX9600, and VX9000.

Note: Use the ‘anyap‘ option to auto provision any AP regardless of its model type.

precedence <1-10000>

Sets the rule precedence. A rule with a lower value has a higher precedence.

profile <DEVICE-PROFILE- NAME>

Sets the device profile for this provisioning policy. The selected device profile must be appropriate for the device being provisioned. For example, use an AP505 device profile for an AP505 . Using an inappropriate device profile can result in unpredictable results. Provide a device profile name.

Provide a device profile name (should be existing and configured). Or a template with appropriate substitution tokens, such as 'campus-$MODEL[1:6]', 'FQDN[1:4]-indoor'.

rf-domain <RF-DOMAIN-NAME>

Sets the RF Domain for this auto provisioning policy. The provisioning policy is only applicable to devices that try to become a part of the specified RF Domain. Provide the full RF Domain name OR use a string alias to identify the RF Domain.

Provide the full RF Domain name or an alias (should be existing and configured). Or a template with appropriate substitution tokens, such as '$CDP[1:7]', '$DNS-SUFFIX[1:5]'.

Note: Use the built-in string alias or a user-defined string alias. String aliases allow you to configure APs in the same RF Domain as the adopting controller. A string alias maps a name to an arbitrary string value, for example, ‘alias string $DOMAIN test.example_company.com‘. In this example, the string-alias $DOMAIN is mapped to the string: test.example_company.com.
area <AREA-NAME> Matches the area of deployment. This option is not applicable to the ‘rf-domain‘ parameter.
  • <AREA-NAME> – Enter a 64 character maximum deployment area name assigned to this policy. Devices with matching area names are adopted.
cdp-match <LOCATION-SUBSTRING> Matches a substring in a list of CDP snoop strings (case insensitive). For example, if an access point snooped 3 devices: controller1.example.com, controller2.example.com, and controller3.example.com, 'controller1', ‘example‘, 'example.com', are examples of the substrings that will match.
  • <LOCATION-SUBSTRING> – Specify the value to match. Devices matching the specified value are adopted.
dhcp-option <DHCP-OPTION> Matches the value found in DHCP vendor option 191 (case insensitive). DHCP vendor option 191 can be setup to communicate various configuration parameters to an AP. The value of the option in a string in the form of tag=value separated by a semicolon, for example 'tag1=value1;tag2=value2;tag3=value3'. The access point includes the value of tag 'rf-domain', if present.
  • <DHCP-OPTION> – Specify the DHCP option. Devices matching the specified value are adopted.
floor <FLOOR-NAME> Matches the floor name. This option is not applicable to the ‘rf-domain‘ parameter.
  • <FLOOR-NAME> – Enter a 32 character maximum deployment floor name assigned to this policy. Devices with matching floor names are adopted.

fqdn <FQDN>

Matches a substring to the FQDN (Fully Qualified Domain Name) of a device (case insensitive)

FQDN is a domain name that specifies its exact location in the DNS hierarchy. It specifies all domain levels, including its top-level domain and the root domain. This parameter allows a device to adopt based on its FQDN value.

  • <FQDN> – Specify the FQDN name. Devices matching the specified value are adopted.

ip [<START-IP> <END-IP>| <IP/MASK>]

Adopts a device if its IP address matches the specified IPv4 address or is within the specified IP address range. Or if the device is a part of the specified subnet.

  • <START-IP> – Specify the first IPv4 address in the range.
    • <END-IP> – Specify the last IPv4 address in the range.
  • <IP/MASK> – Specify the IPv4 subnet and mask to match against the device‘s IP address.
ipv6 [<START-IP> <END-IP>| <IP/MASK>]

Adopts a device if its IP address matches the specified IPv6 address or is within the specified IP address range. Or if the device is a part of the specified subnet.

  • <START-IP> – Specify the first IPv6 address in the range.
    • <END-IP> – Specify the last IPv6 address in the range.
  • <IP/MASK> – Specify the IPv6 subnet and mask to match against the device‘s IPv6 address.

lldp-match <LLDP-STRING>

Matches a substring in a list of LLDP (Link Layer Discovery Protocol) snoop strings (case insensitive). For example, if an Access Point snooped 3 devices: controller1.example.com, controller2.example.com and controller3.example.com,'controller1', 'example', 'example.com', are substrings match.

LLDP is a vendor neutral link layer protocol that advertises a network device‘s identity, capabilities, and neighbors on a local area network.

  • <LLDP-STRING> – Specify the LLDP string. Devices matching the specified value are adopted.

mac <START-MAC> {<END-MAC>}

Adopts a device if its MAC address matches the specified MAC address or is within the specified MAC address range <START-MAC> – Specify the first MAC address in the range. Provide this MAC address if you want to match for a single device.

  • <END-MAC> – Optional. Specify the last MAC address in the range.

model-number <MODEL-NUMBER>

Adopts a device if its model number matches <MODEL-NUMBER>

  • <MODEL-NUMBER> – Specify the model number to match.

serial-number <SERIAL-NUMBER>

Adopts a device if its serial number matches <SERIAL-NUMBER>

  • <SERIAL-NUMBER> – Specify the serial number to match.

vlan <VLAN-ID>

Adopts a device if its VLAN matches <VLAN-ID>

  • <VLAN-ID> – Specify the VLAN ID.

Usage Guidelines: Built-in Tokens & Alias

Following are the built-in tokens that can be used to identify the devices to adopt:
$FQDN      - references FQDN of adopting device
$CDP       - references CDP Device Id of the wired switch to which adopting device is connected
$LLDP      - references LLDP System Name of wired switch to which adopting device is connected
$DHCP      - references DHCP Option Value received by the adopting device
$SN        - references SERIAL NUMBER of adopting device
$MODEL     - references MODEL NUMBER of adopting device
$DNS-SUFFIX - references FQDN excluding the hostname of the adopting device
$CDP-SUFFIX - references CDP excluding the hostname of the adopting device
$LLDP-SUFFIX - references LLDP excluding the hostname of the adopting device
Following is the built-in alias that can be used to identify the RF Domain of devices to adopt:
$AUTO-RF-DOMAIN - rf-domain of adopting device

Examples

nx9500-6C8809(config-auto-provisioning-policy-test)#adopt ap8432 precedence 5 profile default-ap8432 rf-domain TechPubs vlan 1
nx9500-6C8809(config-auto-provisioning-policy-test)#show context
auto-provisioning-policy test
 adopt ap8432 precedence 5 profile default-ap8432 rf-domain TechPubs vlan 1
nx9500-6C8809(config-auto-provisioning-policy-test)#
nx9500-6C8809(config-auto-provisioning-policy-test)#show wireless ap configured
---------------------------------------------------------------------------------------
 IDX      NAME              MAC             PROFILE       RF-DOMAIN       ADOPTED-BY
---------------------------------------------------------------------------------------
 1   ap8432-711728    B4-C7-99-71-17-28   default-ap8432   default    00-23-68-22-9D-58
---------------------------------------------------------------------------------------
nx9500-6C8809(config-auto-provisioning-policy-test)#

Related Commands

no

Removes an adopt device rule from this Auto Provisioning Policy
9037762-01 Rev AA