interface bsi¶
Bridged service interface
bsi Specification¶
Parameter
Value
Type
Collection
Object Key(s)
ifnum
Collection Name
Collection URI
/axapi/v3/interface/bsi
Element Name
bsi
Element URI
/axapi/v3/interface/bsi/{ifnum}
Element Attributes
bsi_attributes
Partition Visibility
shared
Statistics Data URI
/axapi/v3/interface/bsi/{ifnum}/stats
Operational Data URI
/axapi/v3/interface/bsi/{ifnum}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/interface/bsi | ||
Create List | POST | /axapi/v3/interface/bsi | ||
Get Object | GET | /axapi/v3/interface/bsi/{ifnum} | ||
Get List | GET | /axapi/v3/interface/bsi | ||
Modify Object | POST | /axapi/v3/interface/bsi/{ifnum} | ||
Replace Object | PUT | /axapi/v3/interface/bsi/{ifnum} | ||
Replace List | PUT | /axapi/v3/interface/bsi | ||
Delete Object | DELETE | /axapi/v3/interface/bsi/{ifnum} |
bsi-list¶
bsi-list is JSON List of bsi attributes
bsi-list : [
]
bsi attributes¶
action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: disable
ifnum
Description Bridged Service virtual interface number
Type: number
Range: 1-1
ip
Description: ip is a JSON Block. Please see below for ip
Type: Object
Reference Object: /axapi/v3/interface/bsi/{ifnum}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for ipv6
Type: Object
Reference Object: /axapi/v3/interface/bsi/{ifnum}/ipv6
name
Description Name for the interface
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-bsi-tmpl
sampling-enable
Type: List
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘packets_input’: Input packets; ‘bytes_input’: Input bytes; ‘received_broadcasts’: Received broadcasts; ‘received_multicasts’: Received multicasts; ‘received_unicasts’: Received unicasts; ‘input_errors’: Input errors; ‘crc’: CRC; ‘frame’: Frames; ‘runts’: Runts; ‘giants’: Giants; ‘packets_output’: Output packets; ‘bytes_output’: Output bytes; ‘transmitted_broadcasts’: Transmitted broadcasts; ‘transmitted_multicasts’: Transmitted multicasts; ‘transmitted_unicasts’: Transmitted unicasts; ‘output_errors’: Output errors; ‘collisions’: Collisions; ‘giants_output’: Output Giants; ‘rate_pkt_sent’: Packet sent rate packets/sec; ‘rate_byte_sent’: Byte sent rate bits/sec; ‘rate_pkt_rcvd’: Packet received rate packets/sec; ‘rate_byte_rcvd’: Byte received rate bits/sec; ‘load_interval’: Load Interval; ‘transmit_drops’: Transmit Drops; ‘receive_drops’: Receive Drops; ‘input_utilization’: Input Utilization; ‘output_utilization’: Output Utilization;
Type: string
Supported Values: all, packets_input, bytes_input, received_broadcasts, received_multicasts, received_unicasts, input_errors, crc, frame, runts, giants, packets_output, bytes_output, transmitted_broadcasts, transmitted_multicasts, transmitted_unicasts, output_errors, collisions, giants_output, rate_pkt_sent, rate_byte_sent, rate_pkt_rcvd, rate_byte_rcvd, load_interval, transmit_drops, receive_drops, input_utilization, output_utilization
ip¶
Specification
Value
Type
object
address-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip_address-list¶
Specification
Value
Type
list
Block object keys
ipv4-address
Description IP address
Type: string
Format: ipv4-address
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
ipv6¶
Specification
Value
Type
object
address-list
Type: List
ipv6-enable
Description Enable IPv6 processing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipv6_address-list¶
Specification
Value
Type
list
Block object keys
anycast
Description Configure an IPv6 anycast address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-addr
Description Set the IPv6 address of an interface
Type: string
Format: ipv6-address-plen
link-local
Description Configure an IPv6 link local address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0