network lldp¶
Configure LLDP
lldp Specification¶
Type Configuration Resource Element Name lldp Element URI /axapi/v3/network/lldp Element Attributes lldp_attributes Schema lldp schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/network/lldp | ||
Get Object | GET | /axapi/v3/network/lldp | ||
Modify Object | POST | /axapi/v3/network/lldp | ||
Replace Object | PUT | /axapi/v3/network/lldp | ||
Delete Object | DELETE | /axapi/v3/network/lldp |
lldp attributes¶
enable-cfg
Description: enable-cfg is a JSON Block. Please see below for enable-cfg
Type: Object
management-address
Description: management-address is a JSON Block. Please see below for management-address
Type: Object
Reference Object: /axapi/v3/network/lldp/management-address
notification-cfg
Description: notification-cfg is a JSON Block. Please see below for notification-cfg
Type: Object
system-description
Description Configure lldp system description
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
system-name
Description Configure lldp system name
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
tx-set
Description: tx-set is a JSON Block. Please see below for tx-set
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management-address¶
Specification Type object dns-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/dns/{dns}
ipv4-addr-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/ipv4-addr/{ipv4}
ipv6-addr-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/ipv6-addr/{ipv6}
management-address_ipv6-addr-list¶
Specification Type list Block object keys interface-ipv6
Description: interface-ipv6 is a JSON Block. Please see below for management-address_ipv6-addr-list_interface-ipv6
Type: Object
ipv6
Description Configure lldp management-address, subtype is ipv6 (lldp management-address ipv6 address)
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management-address_ipv6-addr-list_interface-ipv6¶
Specification Type object ipv6-eth
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
ipv6-mgmt
Description configure lldp management-address interface management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-ve
Description configure lldp management-address interface ve (lldp management-address interface port number)
Type: number
Range: 2-4094
management-address_ipv4-addr-list¶
Specification Type list Block object keys interface-ipv4
Description: interface-ipv4 is a JSON Block. Please see below for management-address_ipv4-addr-list_interface-ipv4
Type: Object
ipv4
Description Configure lldp management-address, subtype is ipv4 (lldp management-address ipv4 address)
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management-address_ipv4-addr-list_interface-ipv4¶
Specification Type object ipv4-eth
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
ipv4-mgmt
Description configure lldp management-address interface management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv4-ve
Description configure lldp management-address interface ve (lldp management-address interface port number)
Type: number
Range: 2-4094
management-address_dns-list¶
Specification Type list Block object keys dns
Description Configure lldp management-address, subtype is dns (lldp management-address dns address)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
interface
Description: interface is a JSON Block. Please see below for management-address_dns-list_interface
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management-address_dns-list_interface¶
Specification Type object ethernet
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
Mutual Exclusion: ethernet ve and management are mutually exclusive
management
Description configure lldp management-address interface management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: management ethernet and ve are mutually exclusive
ve
Description configure lldp management-address interface management (lldp management-address interface port number)
Type: number
Range: 2-4094
Mutual Exclusion: ve ethernet and management are mutually exclusive
notification-cfg¶
Specification Type object interval
Description Configure lldp notification interval, default is 30 (The lldp notification interval value, default is 30)
Type: number
Range: 5-3600
Default: 30
notification
Description Enable lldp notification
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx-set¶
Specification Type object fast-count
Description Configure lldp tx fast count value (The lldp tx fast count value, default is 4)
Type: number
Range: 1-8
Default: 4
fast-interval
Description Configure lldp tx fast interval value (The lldp tx fast interval value, default is 1)
Type: number
Range: 1-3600
Default: 1
hold
Description Configure lldp tx hold multiplier (The lldp tx hold value, default is 4)
Type: number
Range: 1-10
Default: 4
reinit-delay
Description Configure lldp tx reinit delay (The lldp tx reinit_delay value, default is 2)
Type: number
Range: 1-10
Default: 2
tx-interval
Description Configure lldp tx interval (The lldp tx interval value, default is 30)
Type: number
Range: 1-3600
Default: 30
enable-cfg¶
Specification Type object enable
Description Enable lldp
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rx
Description Enable lldp rx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx
Description Enable lldp tx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0