beacon

Prev Next

beacon add l3

beacon add l3 - Add a new beacon layer-3 instance and specify its attributes

Description:

Configure a beacon layer-3 instance for management purposes. A beacon may be configured to discover remote devices by sending a special frame on the network using the IP settings provided.

Syntax:

beacon add l3 name {<beacon-name>} 
            {domain-id {<domain>}} |
            {state {enable|disable}} |
            {rate {<transmission rate>}} |
            {dst-ip {<ip-addr>}} |
            {use-interface {enable|disable}} |
            {interface {<interface name>}} |
            {use-relay-ip {enable|disable}} |
            {relay-ip {<ip-addr>}} |
            {relay-dst-subnet {<ip-addr>}} |
            {ip-config-mode {local|auto|dhcp|auto-static}} |
            {subnet  {<ip-addr>}} |
            {netmask {<ip-addr>}} | 
            {gateway {<ip-addr>}} |
            {ip-exclusion {<ip-addr1, ip-addr2, ...>}} |            
            {dhcp-hostname-option <none,custom,serial-number,current>} |
            {dhcp-client-id-option <none,custom,serial-number>} |
            {dhcp-hostname <hostname>} |
            {dhcp-client-id <client-id>} |     
            {id-mismatch {enable|disable} |
            {adv-ip {<ip-addr>}} }}+

Parameters:

Parameter Description
name The name to assign to the beacon instance.
domain The name of the discovery domain ID.
state Enable or disable beacon frame transmission.
rate Transmission rate of beacon frames, in seconds <3, 60, 600, 3600>.
dst-ip When neither of the use-interface and use-relay-ip options are used, the beacon frames are sent to this address.
use-interface Enable usage of IP settings defined by the system interface specified by the interface argument.
interface The name of a system interface. The interface must exist on this system. The IP settings of this interface will be used to compute the directed broadcast IP address to use to send the beacon frames.
use-relay-ip Enable sending of frame directly to the DHCP Relay IP address specified in the relay-ip argument.
relay-ip The DHCP Relay Agent IP address. The beacon frames are sent to this DHCP Relay IP address in order to reach remote subnets. The DHCP Relay must be configured to relay the beacon layer-3 frames which are based on DHCPOFFER frames.
relay-dst-subnet When used with a DHCP Relay Agent, this is the destination subnet i.e. the subnet to reach on the other side of the DHCP Relay.
ip-config-mode The IP configuration mode to be used by the remote device.
subnet IP subnet used in Auto and Auto-Static IP configuration modes.
netmask IP netmask used in Auto and Auto-Static IP configuration modes.
gateway IP gateway used in Auto and Auto-Static IP configuration modes.
ip-exclusion This is a comma-separated list of IP addresses that the remote unit must exclude when computing an IP address in Auto and Auto-Static IP configuration modes. Up to 100 IP addresses can be specified. IP address ranges can be expressed with dash (-) separated IP addresses.
dhcp-hostname-option Tell the remote unit what option to use as a hostname in its DNS configuration. Used only in DHCP IP configuration mode.
dhcp-client-id-option Tell the remote unit what option to use as a client ID in its DNS configuration. Used only in DHCP IP configuration mode.
dhcp-hostname The hostname to use when the hostname <custom> option is chosen. Used only in DHCP IP configuration mode.
dhcp-client-id The client ID to use when the client ID <custom> option is chosen. Used only in DHCP IP configuration mode.
id-mismatch When enabled, forces the remote system to accept beacon even if domain IDs do not match.
adv-ip IP address of an inventory collecting unit.

beacon delete l3

beacon delete l3 - Delete a beacon layer-3 instance

Description:

Delete an existing beacon layer-3 instance.

Syntax:

beacon delete l3 <beacon-name>

Parameters

Parameter Description
<beacon-name> The name to assign to the beacon instance.

beacon edit l3

beacon edit l3 - Edit the attributes of an existing beacon layer-3 instance

Description:

Configure a beacon layer-3 instance for management purpose. A beacon may be configured to discover remote devices by sending a special frame on the network using the IP settings provided.

Syntax:

beacon edit l3 <beacon-name>
            {name {<beacon-name>}} | 
            {domain-id {<domain>}} |
            {state {enable|disable}} |
            {rate {<transmission rate>}} |
            {dst-ip {<ip-addr>}} |
            {use-interface {enable|disable}} |
            {interface {<interface name>}} |
            {use-relay-ip {enable|disable}} |
            {relay-ip {<ip-addr>}} |
            {relay-dst-subnet {<ip-addr>}} |
            {ip-config-mode {local|auto|dhcp|auto-static}} |
            {subnet  {<ip-addr>}} |
            {netmask {<ip-addr>}} | 
            {gateway {<ip-addr>}} |
            {ip-exclusion {<ip-addr1, ip-addr2, ...>}} |            
            {dhcp-hostname-option <none,custom,serial-number,current>} |
            {dhcp-client-id-option <none,custom,serial-number>} |
            {dhcp-hostname <hostname>} |
            {dhcp-client-id <client-id>} |     
            {id-mismatch {enable|disable} |
            {adv-ip {<ip-addr>}} }}+

Parameters:

Parameter Description
name The name to assign to the beacon instance.
domain The name of the discovery domain ID.
state Enable or disable beacon frame transmission.
rate Transmission rate of beacon frames, in seconds <3, 60, 600, 3600>.
dst-ip When neither of the use-interface and use-relay-ip options are used, the beacon frames are sent to this address.
use-interface Enable usage of IP settings defined by the system interface specified by the interface argument.
interface The name of a system interface. The interface must exist on this system. The IP settings of this interface will be used to compute the directed broadcast IP address to use to send the beacon frames.
use-relay-ip Enable sending of frame directly to the DHCP Relay IP address specified in the relay-ip argument.
relay-ip The DHCP Relay Agent IP address. The beacon frames are sent to this DHCP Relay IP address in order to reach remote subnets. The DHCP Relay must be configured to relay the beacon layer-3 frames which are based on DHCPOFFER frames.
relay-dst-subnet When used with a DHCP Relay Agent, this is the destination subnet i.e. the subnet to reach on the other side of the DHCP Relay.
ip-config-mode The IP configuration mode to be used by the remote device.
subnet IP subnet used in Auto and Auto-Static IP configuration modes.
netmask IP netmask used in Auto and Auto-Static IP configuration modes.
gateway IP gateway used in Auto and Auto-Static IP configuration modes.
ip-exclusion This is a comma-separated list of IP addresses that the remote unit must exclude when computing an IP address in Auto and Auto-Static IP configuration modes. Up to 100 IP addresses can be specified. IP address ranges can be expressed with dash (-) separated IP addresses.
dhcp-hostname-option Tell the remote unit what option to use as a hostname in its DNS configuration. Used only in DHCP IP configuration mode.
dhcp-client-id-option Tell the remote unit what option to use as a client ID in its DNS configuration. Used only in DHCP IP configuration mode.
dhcp-hostname The hostname to use when the hostname <custom> option is chosen. Used only in DHCP IP configuration mode.
dhcp-client-id The client ID to use when the client ID <custom> option is chosen. Used only in DHCP IP configuration mode.
id-mismatch When enabled, forces the remote system to accept beacon even if domain IDs do not match.
adv-ip IP address of an inventory collecting unit.

beacon send l3 one-shot

beacon send l3 one-shot - Send a one-shot beacon layer-3 frame

Description:
Immediately sends one beacon layer-3 frame based on the configuration of the chosen beacon instance.

Syntax:

beacon send l3 one-shot <beacon-name>

Parameters:

Parameter Description
<beacon-name> The name of the beacon instance configuration to use for sending the one frame. The beacon-name must refer to an existing instance and the instance must be enabled.

beacon show l3 configuration

beacon show l3 configuration - Show configuration of beacon layer-3 instance(s)

Description:

Specifying a beacon name provides detailed configuration about this beacon, if not, the command provides a summary of configurations for all beacons.

Syntax:

beacon show l3 configuration [<beacon-name>]

Parameters:

Parameter Description
<beacon-name> The name of the beacon instance to show.

© 2025 Cisco and/or its affiliates. All rights reserved.
 
For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms

For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks