Note

The documentation you're currently reading is for version 2.3.0. Click here to view documentation for the latest stable version.

Network Essentials Actions

This is a reference documentation for Network Essentials Actions and Workflows to automate Brocade VDX and SLX switches. These actions can be used as independent actions, or as part of a more complex workflow. Actions can be manually triggered, or they can be tied to sensors using rules.

Most of the actions below can be used to automate Brocade SLX or VDX switches, however there are few actions that are only valid for VDX switches as outlined below. If an action is only valid for VDX it will be documented in the action details, otherwise the action is supported for both VDX and SLX.

Edge Ports Configuration

create_l2_port_channel

Description: Create an L2 port channel (LAG or vLAG) in Static or LACP mode

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type ethernet/gigabitethernet/tengigabitethernet/fortygigabitethernet/hundredgigabitethernet

Choose from:

  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • ethernet

Default: tengigabitethernet

ports

Single or list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 1/13, 1/14

Type: array

port_channel_id

Port channel interface number.<NUMBER:1-6144>

Type: string

mode

Port channel type

Choose from:

  • standard
  • brocade

Default: standard

protocol

Port channel mode

Choose from:

  • active
  • passive
  • modeon

Default: active

port_channel_desc

Port channel Interface description name without any space

Type: string

autopick_port_channel_id

Description: Auto pick the lowest available Port Channel ID on the device.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

create_vlan

Description: Create a VLANs and provide VLAN descriptions

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

Single VLAN/range of VLANS/batch wise values. For example 21 or 21-26 or 10,13-14,89-91

Type: string

vlan_desc

VLAN description without any space. Same description is used when creating multiple VLANs

Type: string

create_switchport_access

Description: Configure a port channel or a physical interface as an Access interface.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: tengigabitethernet

intf_name

Interface name, for VDX in 3-tuple format (24/0/1), SLX in 2-tuple format (24/1)

Type: string

vlan_id

VLAN ID to be configure on the interface

Type: string

create_switchport_trunk

Description: Configure port channel or a physical interface as a Trunk interface.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: tengigabitethernet

intf_name

Interface name, for VDX in 3-tuple format (24/0/1), SLX in 2-tuple format (24/1) or Port-channel number <1-6144>.

Type: string

vlan_id

VLAN ID/all to be configured on the interface. e.g 5 or 4-7 or all

Type: string

create_ve

Description: Create a VE, assign IP addresses and VRF on multiple switches.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

Single or list of RBridge IDs separated by comma, for example, 1 or 1,2, 4. This parameter is only applicable for VDX switches.

Type: array

vlan_id

Interface VLAN ID. <NUMBER:1-4090/8191>, can be greater than 4090 only if VF is enabled.

Type: string

ip_address

Single or list of IPv4/IPv6 addresses to be configured on the VE. IPv4/subnet-length or IPv6/prefix-length, for example 10.0.0.10/22, 30.0.0.10/22.

Type: array

vrf_name

VRF name. For example vrf32 or 32

Type: string

ipv6_use_link_local_only

IPv6 link local

Type: boolean

create_vrf

Description: Create Virtual Routing and Forwarding (VRF) instance on the switch for L3 tenants.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vrf_name

VRF name, for example vrf32 or 32

Type: string

rbridge_id

RBridge ID of the switch. This parameter is only applicable for VDX switches.

Type: array

afi

IP address type

Choose from:

  • ipv4
  • ipv6

Default: ipv4

create_vrrpe

Description: Create a VRRPe session on multiple switches by creating VRRPe group and assigning virtual IP

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: string

ve_name

Interface VE name

Type: string

vrid

Virtual group ID

Type: string

virtual_ip

VRRPe virtual IP address without the netmask

Type: string

delete_l2_port_channel

Description: Delete the port channel interface and delete the port chanel configuration from all the member ports

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

port_channel_id

Port-channel interface number <NUMBER:1-6144>

Type: integer

delete_ve

Description: Delete a VE on multiple switches

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

RBridge IDs of the VDX switches, for example 51 or 51,52. This parameter is only applicable for VDX switches.

Type: array

vlan_id

VLAN ID. Allowed range for SLX <NUMBER:1-4090>, for VDX <NUMBER:1-4090/8191> greater than 4090 only if VF is enabled

Type: string

delete_vlan

Description: Delete one or more VLANs on a switch

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

VLAN ID, can be single or range of VLANs. For example 5 or 5-9

Type: string

delete_vrf

Description: Delete a VRF

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

RBridge IDs of the VDX switches, for example 51 or 51,52. This parameter is only applicable for VDX switches.

Type: array

vrf_name

VRF name, for example vrf32 or 32

Type: string

delete_vrrpe

Description: Delete VRRPe group

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

RBridge IDs of the VDX switches, for example 51 or 51,52. This parameter is only applicable for VDX switches.

Type: array

vlan_id

VLAN ID. Allowed range for SLX devices <NUMBER:1-4090>, for VDX <NUMBER:1-4090/8191> greater than 4090 only if VF is enabled

Type: string

vrrpe_group

Virtual extender group ID

Type: string

ip_version

IPv4 or IPv6 group

Type: string

Default: IPv4

set_intf_admin_state

Description: Enable or disable a single physical port, port-channel, loopback or VE interface on a device. Optionally set the interface description.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • ethernet
  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • ve
  • loopback

Default: tengigabitethernet

intf_name

Interface names, port channel numbers or VEs. Examples are 224/0/1, 224/0/2, 52/0/15-16 or 7, 8, 9

Type: string

enabled

Admin setting of the interface(s)

Type: boolean

Default: True

intf_desc

Interface description without any space

Type: string

rbridge_id

RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: string

set_l2_mtu

Description: Set L2 MTU size on physical or port channel interfaces

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: tengigabitethernet

intf_name

Interface names, can be comma separated physical ports, port channel numbers. Examples are 224/0/1, 224/0/2 or 7, 8, 9

Type: array

mtu_size

MTU size in bytes <Number:1522-9216>

Type: integer

set_l3_mtu

Description: Set L3 MTU size on physical or port channel interface

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: tengigabitethernet

intf_name

Interface names, can be comma separated physical ports, port channel numbers. Examples are 224/0/1, 224/0/2 or 7, 8, 9

Type: array

mtu_size

For SLX IPV4/IPV6 MTU size in bytes <Number:1300-9194>. For VDX IPV4 <Number:1300-9100> or IPV6 <Number:1280-9100> MTU size in bytes.

Type: integer

afi

IP version

Choose from:

  • ipv4
  • ipv6

Default: ipv4

configure_mac_move_detection

Description: Configure the switch to enable MAC move detection and set the threshold for number of MAC moves in time-window to trigger the detection.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

move_threshold

MAC move threshold <NUMBER:5-500>

Type: integer

Default: 5

ACL Management

create_acl

Description: Create an Access Control List

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

address_type

ACL address type, ip or ipv6 or mac

Choose from:

  • ip
  • ipv6
  • mac

Default: ip

acl_type

ACL type, extended or standard

Choose from:

  • standard
  • extended
acl_name

Unique name for ACL, can be up to 63 characters long, and must begin with a-z, A-Z or 0-9. You can also use underscore (_) or hyphen (-) in an ACL name, but not as the first character.

Type: string

delete_acl

Description: Delete an existing Access Control List (ACL)

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

acl_name

Name of the ACL to be deleted

Type: string

add_ipv4_rule_acl

Description: Add an L3 IPv4 ACL rule to an existing ACL

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

acl_name

Name of the access list

Type: string

seq_id

Sequence number of the rule, if not specified, the rule is added at the end of the list. Valid range is 0 to 4294967290

Type: integer

action

Action performed by ACL rule

Choose from:

  • permit
  • deny
  • hard-drop

Default: permit

protocol_type

Type of IP packets to be filtered based on protocol. Valid values are <0-255> or key words tcp, udp, icmp or ip

Type: string

source

Source address filters { any | S_IPaddress/mask(0.0.0.255) | host,S_IPaddress } [ source-operator [ S_port-numbers ] ]

Type: string

Default: any

destination

Destination address filters { any | S_IPaddress/mask(0.0.0.255) | host,S_IPaddress } [ source-operator [ S_port-numbers ] ]

Type: string

dscp

Matches the specified value against the DSCP value of the packet to filter. Allowed values are 0 through 63.

Type: string

vlan_id

VLAN interface to which the ACL is bound

Type: integer

count

Enables statistics for the rule

Type: string

Default: False

log

Enables logging for the rule (Available for permit or deny only)

Type: string

Default: False

add_ipv6_rule_acl

Description: Add an L3 IPv6 ACL rule to an existing ACL

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

acl_name

Name of the access list

Type: string

seq_id

Sequence number of the rule, if not specified, the rule is added at the end of the list. Valid range is 0 to 4294967290

Type: integer

action

Action performed by ACL rule

Choose from:

  • permit
  • deny
  • hard-drop

Default: permit

protocol_type

Type of IP packets to be filtered based on protocol. Valid values are 0 through 255 or key words tcp, udp, icmp or ip

Type: string

source

Source address filters { any | S_IPaddress mask | host S_IPaddress } [ source-operator [ S_port-numbers ] ]

Type: string

Default: any

destination

Destination address filters { any | S_IPaddress mask | host S_IPaddress } [ source-operator [ S_port-numbers ] ]

Type: string

dscp

Matches the specified value against the DSCP value of the packet to filter. Can be either a numerical value or DSCP name

Type: string

vlan_id

VLAN interface to which the ACL is bound

Type: integer

count

Enables statistics for the rule

Type: string

Default: False

log

Enables logging for the rule (Available for permit or deny only)

Type: string

Default: False

add_or_remove_l2_acl_rule

Description: Add or remove an ACL rule to or from an L2 ACL

Parameter Description
delete

Indicates add or delete operation. TRUE indicates a remove operation.

Type: boolean

mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

acl_name

Name of the access list

Type: string

seq_id

Sequence number of the rule. For add operation, if not specified, the rule is added at the end of the list.

Type: integer

action

Action to apply on the traffic, either to drop (deny), allow (permit) or force drop (hard-drop)

Choose from:

  • deny
  • permit
  • hard-drop

Default: deny

source

Source filter, can be ‘any’ or ‘host’, or the actual MAC in HHHH.HHHH.HHHH format.

Type: string

Default: any

srchost

The source MAC in HHHH.HHHH.HHHH format. The value is required only when the source is ‘host’.

Type: string

src_mac_addr_mask

Mask for the source MAC in HHHH.HHHH.HHHH format.

Type: string

dst

Destination filter, can be ‘any’ or ‘host’, or the actual MAC of the destination in HHHH.HHHH.HHHH format.

Type: string

Default: any

dsthost

Destination MAC in HHHH.HHHH.HHHH format. The value is required only when the dst is ‘host’

Type: string

dst_mac_addr_mask

Mask for the destination MAC in HHHH.HHHH.HHHH format.

Type: string

ethertype

EtherType, can be ‘arp’, ‘fcoe’, ‘ipv4’ or custom value between 1536 and 65535.

Type: string

Default: arp

vlan

VLAN ID - custom value between 1 and 4096.

Type: integer

count

Enables the packet count

Type: string

Default: False

log

Enables the logging

Type: string

Default: False

delete_ipv4_rule_acl

Description: Delete IPv4 ACL rule from an existing IPv4 ACL

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

acl_name

Name of the ACL (standard or extended) to delete the rule from

Type: string

seq_id

Sequence number of the rule to be deleted

Type: integer

apply_acl

Description: Apply an ACL to a physical port, port channel, VE or management interface.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type, can be a physical port, port channel, VE or management interface

Choose from:

  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • ve
  • loopback
  • ethernet

Default: tengigabitethernet

intf_name

Interface names, can be comma separated physical ports, port channel numbers or VEs. Examples are 224/0/1, 224/0/2 or 4, 5, 6 or 80, 81.

Type: array

rbridge_id

RBridge ID of the VDX switch under which VE will be configured, only needed for VDX device.

Type: string

acl_name

Name of the access list

Type: string

acl_direction

Direction of ACL binding on the specified interface

Choose from:

  • in
  • out

Default: in

traffic_type

Traffic type for the ACL being applied

Choose from:

  • switched
  • routed

remove_acl

Description: Remove an ACL from physical port, port channel, VE or mgmt interface.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • ve
  • loopback
  • ethernet

Default: tengigabitethernet

intf_name

Interface names, can be comma separated physical ports, port channel numbers or VEs. Examples are 224/0/1, 224/0/2 or 7, 8, 9

Type: array

rbridge_id

RBridge ID of the VDX switch. This parameter is only applicable to VDX switches

Type: string

acl_name

ACL name

Type: string

acl_direction

ACL direction

Choose from:

  • in
  • out

Default: in

traffic_type

Traffic type for the ACL being removed

Choose from:

  • switched
  • routed

Validation and Troubleshooting

find_host_ip

Description: Find which switch port a host is connected to using host IP address

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

ip_address

IPv4 or IPv6 address of the VM or physical host to be found

Type: string

Sample Output:

[
  {
    "interface-name": null,
    "is-resolved": "true",
    "age": "02:02:12",
    "interface-type": "unknown",
    "ip-address": "80.0.110.11",
    "entry-type": "dynamic",
    "mac-address": "0000.07ab.839a"
  }
]

find_mac

Description: Find which switch port a host is connected to using host MAC address

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

macs

Single MAC or comma separated list of MACs to be found

Type: array

Sample Output:

[
  {
    "vlanid": "5308",
    "mac-state": "active",
    "mac-address": "22:00:00:11:11:19",
    "mac-type": "dynamic",
    "forwarding-interface": {
    "interface-type": "tengigabitethernet",
    "interface-name": "21/0/1"
    }
  },
  {
    "vlanid": "2",
    "mac-state": "active",
    "mac-address": "00:d0:b0:11:01:01",
    "mac-type": "dynamic",
    "forwarding-interface": {
    "interface-type": "tengigabitethernet",
    "interface-name": "21/0/1"
    }
  }
]

ping_vrf_targets

Description: Ping target IPs from the switch using the specified VRF, uses the default VRF if VRF is not provided

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

targets

One or more comma separated target IP addresses

Type: array

vrf

VRF name

Type: string

Default: default-vrf

timeout_value

Timeout parameter for the ping command. Specifies the time (in seconds) to wait for a response.

Type: integer

Default: 1

count

Count parameter for the ping command. Specifies the number of transmissions (pings).

Type: integer

Default: 4

size

Datagram size

Type: integer

Default: 56

validate_L2_port_channel_state

Description: Validate the port channel state by verifying the sync state of all member ports is 1.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

port_channel_id

Portchannel interface number. <NUMBER:1-6144>

Type: string

Sample Output:

{
  "member-ports": [
    "tengigabitethernet 37/0/12",
    "tengigabitethernet 37/0/13",
    "tengigabitethernet 37/0/14",
    "tengigabitethernet 38/0/11",
    "tengigabitethernet 38/0/12",
    "tengigabitethernet 38/0/13"
  ],
  "state": "in_sync"
}

{
  "member-ports": [
    "tengigabitethernet 37/0/11",
    "tengigabitethernet 38/0/14"
  ],
  "state": "out_of_sync"
}

validate_interface_state

Description: Validate L1 and L2 state for port channel, physical, ve, loopback interface is UP.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • ethernet
  • ve
  • loopback

Default: tengigabitethernet

intf_name

Interface name physical port, port channel number, ve, loopback. Examples are 224/0/1 or 7

Type: string

intf_state

Interface state (up or down)

Choose from:

  • up
  • down
rbridge_id

Single or list of RBridge IDs separated by comma, for example, 1 or 1,2, 4. This parameter is only applicable for VDX switches.

Type: array

Sample Output:

{
  "state": "down",
  "intf": true
}
{
  "state": "up",
  "intf": true
}
{
  "state": false,
  "intf": true
}

validate_interface_vlan

Description: Validate port channel or physical interface belongs to the specified VLAN

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

Single VLAN or range of VLANs, for example 2 or 3-9

Type: string

intf_name

Interface names, can be comma separated physical ports, port channel numbers. Examples are 224/0/1, 224/0/2 or 7, 8, 9

Type: string

intf_mode

Interface mode

Choose from:

  • trunk
  • access

Default: access

{
  "vlan": true
}
{
  "vlan": false
}

validate_vrrpe_state

Description: Validate VRRPe state on multiple switches to ensure one VRRPe master is elected and other switches are in backup mode.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: array

username

Login user name to connect to the device

Type: array

Default: [‘admin’]

password

Login password to connect to the device

Type: array

Default: [‘password’]

vlan_id

VLAN ID. <NUMBER:1-4090/8191>, can be greater than 4090 only if VF is enabled.

Type: string

vrrpe_group

Virtual extender group ID. <NUMBER:1-255>

Type: string

Utility Actions

execute_cli

Description: Execute CLI command and return the result

Parameter Description
mgmt_ip

Ip address of the VDX device

Type: string

username

login username

Type: string

Default: admin

password

login password

Type: string

Default: password

cli_cmd

CLI commands to execute on the specified VDX device

Type: array

get_os_version

Description: Get Operating System (OS) version of a VDX or SLX device

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

get_switch_details

Description: Get switch details from a device

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

VCS Specific Actions

set_l2_system_mtu

Description: Set L2 system MTU on the VCS fabric or vLag pairs. Only supported on VDX devices.

Parameter Description
mgmt_ip

Virtual IP of VCS Fabric or management IP of the switch.

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

mtu_size

MTU size in bytes <Number:1522-9216>

Type: integer

set_l3_system_mtu

Description: Set L3 system MTU on the VCS fabric or vLag pair. Only supported on VDX devices.

Parameter Description
mgmt_ip

Virtual IP of the VCS Fabric or management IP of the switch.

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

mtu_size

MTU size in bytes <Number:1300-9100> for IPV4, <Number:1280-9100> for IPV6

Type: integer

afi

IP version

Choose from:

  • ipv4
  • ipv6

Default: ipv4

configure_mgmt_virtual_ip

Description: Configure management virtual IP on the principal switch of a VCS cluster.

Parameter Description
username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

mgmt_ip

Management IP of the principal RBridge

Type: string

mgmt_vip

Virtual management IP and mask of the VCS Fabric, examples for IPv4, IPv6: 10.1.1.1/22, 2620:100:0:fa48:34::50/64.

Type: string

find_my_host_vcs

Description: Find the switch port in a VCS fabric to which a virtual or physical host is connected using host IP

Parameter Description
username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

mgmt_ip

Virtual management IP address of the VCS fabric

Type: string

ip_address

Host IP address

Type: string

Known Issues

This section includes the known issues in Network Essentials 1.0.0 release. Common issues are listed in the beginning of the section and the issues specific to a particular network device platform are organized under the corresponding platform sub-section.

  1. ID:277 remove_acl fails with an unknown error on port_channel interfaces
  2. ID:312 set_l3_mtu returns success when setting the MTU size back to default value but the switch is not configured with the default MTU size.
  3. ID:300 set_l2_mtu returns success when setting the MTU size back to default value but the switch is not configured with the default MTU size.

SLX:

  1. ID:314 set_l3_mtu not supported on VE interface.
  2. ID:309 validate_interface_state not supported on VE interface.
  3. ID:308 create_ve times out on SLX.
  4. ID:311 ping_vrf_targets is not supported on SLX.

VDX:

  1. ID:303 validate_interface_vlan doesn’t validate GVLANs i.e. VLANs with ID over 4K.