dellemc.os9/roles/os9_interface

Interface role

This role facilitates the configuration of interface attributes. It supports the configuration of admin state, description, MTU, IP address, IP helper, suppress_ra and port mode. This role is abstracted for Dell EMC PowerSwitch platforms running Dell EMC OS9.

The interface role requires an SSH connection for connectivity to a Dell EMC OS9 device. You can use any of the built-in OS connection variables.

Role variables

• Role is abstracted using the ansible_network_os variable that can take dellemc.os9.os9 as the value
• If os9_cfg_generate is set to true, the variable generates the role configuration commands in a file
• Any role variable with a corresponding state variable setting to absent negates the configuration of that variable
• Setting an empty value for any variable negates the corresponding configuration
• os9_interface (dictionary) holds a dictionary with the interface name; interface name can correspond to any of the valid OS interfaces with the unique interface identifier name
• For physical interfaces, the interface name must be in format; for logical interfaces, the interface must be in <logical_interfacename> format; physical interface name can be fortyGigE 1/1
• For interface ranges, the interface name must be in range <interface_type> <node/slot/port[:subport]-node/slot/port[:subport]> format;
• Logical interface names can be vlan 1 or port-channel 1
• Variables and values are case-sensitive

NOTE: Only define supported variables for the interface type. For example, do not define the switchport variable for a logical interface, and do not configure port mode when switchport is present in OS9 devices.

interface name keys

Key	Type	Description	Support
desc	string	Configures a single line interface description	os9
portmode	string	Configures port-mode according to the device type	access and trunk, os9 (hybrid)
switchport	boolean: true,false*	Configures an interface in L2 mode	os9
admin	string: up,down*	Configures the administrative state for the interface; configuring the value as administratively "up" enables the interface; configuring the value as administratively "down" disables the interface	os9
mtu	integer	Configures the MTU size for L2 and L3 interfaces (594 to 12000; 1280 to 65535 to set globally)	os9
fanout	string:dual, single, quad (os9); string:10g-4x, 40g-1x, 25g-4x, 100g-1x, 50g-2x)	Configures fanout to the appropriate value	os9
fanout_speed	string: 10G, 25G, 40G, 50G	Configures speed for the fanout port based on the fanout mode specified	os9
fanout_state	string: present, absent*	Configures the fanout mode to a port if state is set to present	os9
keepalive	boolean: true,false	Configures keepalive on the port if set to true	os9
speed	string:10,100,1000,auto	Configures interface speed parameters	os9
duplex	string: full,half	Configures interface duplex parameters	os9
auto_neg	boolean: true,false	Configures auto-negotiation mode if set to true	os9
cr4_auto_neg	boolean: true,false	Configures auto-negotiation mode on a CR4 interface type if set to true	os9
suppress_ra	string; present,absent	Configures IPv6 router advertisements if set to present	os9
ip_type_dynamic	boolean: true,false	Configures IP address DHCP if set to true (ip_and_mask is ignored if set to true)	os9
ipv6_type_dynamic	boolean: true,false	Configures an IPv6 address for DHCP if set to true (ipv6_and_mask is ignored if set to true)
ipv6_autoconfig	boolean: true,false	Configures stateless configuration of IPv6 addresses if set to true (ipv6_and_mask is ignored if set to true)
class_vendor_identifier	string: present,absent,string	Configures the vendor-class identifier without a user-defined string if set to present; configures a vendor-class identifier with a user-defined string when a string is specified; ignored when ip_type_dynamic is set to false	os9
option82	boolean: true,false*	Configures option82 with the remote-id MAC address if remote_id is undefined; ignored when ip_type_dynamic is set to false	os9
remote_id	string: hostname,mac,string	Configures option82 with the specified remote-id; ignored when option82 is set to false	os9
vrf	string	Configures the specified VRF to be associated to the interface	os9
min_ra	string	Configures RA minimum interval time period	os9
max_ra	string	Configures RA maximum interval time period	os9
ip_and_mask	string	Configures the specified IP address to the interface; configures the specified IP address to the interface VLAN on devices (192.168.11.1/24 format)	os9
ip_and_mask_secondary	string	Configures the specified IP address as secondary address to the interface on os9 an devices (192.168.11.2/24 format)	os9
ip_virtual_gateway_ip	string	Configures an anycast gateway IP address for a VxLAN virtual network
secondary_ip_state	string: absent,present*	Deletes the secondary IP address if set to absent	os9
ipv6_and_mask	string	Configures a specified IPv6 address to the interface; configures a specified IP address to the interface VLAN on devices (2001:4898:5808:ffa2::1/126 format)	os9
state_ipv6	string: absent,present*	Deletes the IPV6 address if set to absent
ipv6_reachabletime	integer	Configures the reachability time for IPv6 neighbor discovery (0 to 3600000)	os9
ip_helper	list	Configures DHCP server address objects (see ip_helper.*)	os9
ip_helper.ip	string (required)	Configures the IPv4 address of the DHCP server (A.B.C.D format)	os9
ip_helper.state	string: absent,present*	Deletes the IP helper address if set to absent	os9

NOTE: Asterisk (*) denotes the default value if none is specified.

Connection variables

Ansible Dell EMC network roles require connection information to establish communication with the nodes in your inventory. This information can exist in the Ansible group_vars or host_vars directories or inventory, or in the playbook itself.

Key	Required	Choices	Description
ansible_host	yes		Specifies the hostname or address for connecting to the remote device over the specified transport
ansible_port	no		Specifies the port used to build the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_PORT option is used; it defaults to 22
ansible_ssh_user	no		Specifies the username that authenticates the CLI login for the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_USER environment variable value is used
ansible_ssh_pass	no		Specifies the password that authenticates the connection to the remote device
ansible_become	no	yes, no*	Instructs the module to enter privileged mode on the remote device before sending any commands; if value is unspecified, the ANSIBLE_BECOME environment variable value is used, and the device attempts to execute all commands in non-privileged mode
ansible_become_method	no	enable, sudo*	Instructs the module to allow the become method to be specified for handling privilege escalation; if value is unspecified, the ANSIBLE_BECOME_METHOD environment variable value is used
ansible_become_pass	no		Specifies the password to use if required to enter privileged mode on the remote device; if ansible_become is set to no this key is not applicable
ansible_network_os	yes	/os9, null*	Loads the correct terminal and cliconf plugins to communicate with the remote device

NOTE: Asterisk (*) denotes the default value if none is specified.

Example playbook

This example uses the os9_interface role to set up description, MTU, admin status, portmode, and switchport details for an interface. The example creates a hosts file with the switch details and corresponding variables. The hosts file should define the ansible_network_os variable with corresponding Dell EMC OS9 name.

When os9_cfg_generate is set to true, the variable generates the configuration commands as a .part file in build_dir path. By default, this variable is set to false. The example writes a simple playbook that only references the os9_interface role.

Sample hosts file

leaf3 ansible_host= <ip_address> 

Sample host_vars/leaf3

hostname: "leaf3"
ansible_become: yes
ansible_become_method: xxxxx
ansible_become_pass: xxxxx
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellemc.os9.os9
build_dir: ../temp/os9

os9_interface:
    TenGigabitEthernet 1/8:
      desc: "Connected to Spine1"
      portmode:
      switchport: False
      mtu: 2500
      admin: up
      auto_neg: true
      speed: auto
      duplex: full
      keepalive: true
      ipv6_and_mask: 2001:4898:5808:ffa2::5/126
      suppress_ra : present
      ip_type_dynamic: true
      ip_and_mask: 192.168.23.22/24
      class_vendor_identifier: present
      option82: true
      remote_id: hostname
    fortyGigE 1/9:
      desc: "Connected to Spine2"
      switchport: False
      mtu: 2500
      admin: up
      cr4_auto_neg: true
      ip_and_mask: 192.168.234.20/31
      ip_and_mask_secondary: "192.168.234.21/31"
      secondary_ip_state: present
      suppress_ra: absent
      ip_type_dynamic: false
      class_vendor_identifier: absent
      option82: true
      remote_id: hostname
      ipv6_and_mask: 2001:4898:5808:ffa2::9/126
      flowcontrol:
        mode: "receive"
        enable: "on" 
        state: "present"
     vlan 100:
       mtu: 4096
       admin: down
       ip_and_mask:
       ipv6_and_mask: 2002:4898:5408:faaf::1/64
       suppress_ra: present
       state_ipv6: absent
       ip_helper:
          - ip: 10.0.0.36
            state: absent
        ipv6_reachabletime: 600000
     virtual-network 888:
       vrf: "green"
       desc: "virtual-network interface"
       ip_and_mask: "172.17.17.251/24"
       ip_virtual_gateway_ip: "172.17.17.1"
       admin: up
     vlan 20:
       suppress_ra: absent
       min_ra: 3
       max_ra: 4
       admin: up

Simple playbook to setup system — leaf.yaml

- hosts: leaf3
  roles:
     - dellemc.os9.os9_interface

Run

ansible-playbook -i hosts leaf.yaml

(c) 2017-2020 Dell Inc. or its subsidiaries. All rights reserved.