amnesh.soodar.soodar_interfaces module – Manages interface attributes of Amnesh Soodar network devices

Note

This module is part of the amnesh.soodar collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install https://soodar.ir/ansible/amnesh.soodar.tar.gz.

To use it in a playbook, specify: amnesh.soodar.soodar_interfaces.

Synopsis

• This module manages the interface attributes of Amnesh Soodar network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter	Comments
config list / elements=dictionary	A dictionary of interface options
description string	Interface description.
enabled boolean	Administrative state of the interface. Set the value to true to administratively enable the interface or false to disable it. Choices: false true ← (default)
mac_address string	H.H.H MAC address.
mtu string	MTU for a specific interface. Must be a number between 64 and 9600. Applicable for Ethernet interfaces only.
name string / required	Full name of interface, e.g. ge0, tunnel20.
service_policy dictionary	Service policy configuration
input string	Assign policy-map to the input of an interface
output string	Assign policy-map to the output of an interface
running_config string	This option is used only with state parsed. The value of this option should be the output received from the Soodar device by executing the command show running-config | section ^interface. The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module’s argspec and the value is then returned in the parsed key within the result.
state string	The state the configuration should be left in The states rendered, gathered and parsed does not perform any change on the device. The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required. The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result. The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the same format as the output of command show running-config | include ‘ip route|ipv6 route’ executed on device. For state parsed active connection to remote host is not required. The state purged negates virtual/logical interfaces that are specified in task from running-config. Choices: "merged" ← (default) "replaced" "overridden" "deleted" "rendered" "gathered" "purged" "parsed"

Notes

Note

• Tested against Soodar Version 23.11

• This module works with connection amnesh.soodar.network_cli.

• The module examples uses callback plugin (stdout_callback = yaml) to generate task output in yaml format.

Examples

# Using merged

# Before state:
# -------------
#
# Router# sh running-config | section interface
# interface loopback888
#  no ip address
# interface loopback999
#  no ip address
# interface ge1
#  ip address dhcp
# interface ge2
#  description Configured and Merged by Ansible Network
#  ip address dhcp
#  speed 1000
# interface ge3
#  no ip address
#  speed 1000
# interface ge4
#  no ip address
#  shutdown

- name: Merge provided configuration with device configuration
  amnesh.soodar.soodar_interfaces:
    config:
      - name: ge2
        description: Configured and Merged by Ansible Network
        enabled: true
      - name: ge3
        description: Configured and Merged by Ansible Network
        mtu: 3800
        enabled: false
        speed: 100
    state: merged

# Task Output
# -----------
#
# before:
# - enabled: true
#   name: ge1
# - description: Configured and Merged by Ansible Network
#   enabled: true
#   name: ge2
#   speed: '1000'
# - description: Configured and Merged by Ansible Network
#   enabled: false
#   mtu: 3800
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: true
#   name: loopback888
# - enabled: true
#   name: loopback999
# commands:
# - interface ge3
# - description Configured and Merged by Ansible Network
# - speed 100
# - mtu 3800
# - shutdown
# after:
# - enabled: true
#   name: ge1
# - description: Configured and Merged by Ansible Network
#   enabled: true
#   name: ge2
#   speed: '1000'
# - description: Configured and Merged by Ansible Network
#   enabled: true
#   mtu: 2800
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: true
#   name: loopback888
# - enabled: true
#   name: loopback999

# After state:
# ------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
# interface loopback999
#  no ip address
# interface ge1
#  ip address dhcp
# interface ge2
#  description Configured and Merged by Ansible Network
#  ip address dhcp
#  speed 1000
# interface ge3
#  description Configured and Merged by Ansible Network
#  mtu 3800
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown

# Using merged - with mode attribute

# Before state:
# -------------
#
# Router# show running-config | section ^interface
# interface ge1
#  description Configured by Ansible
# interface ge2
#  description This is test
# interface ge3
#  description This is test

- name: Merge provided configuration with device configuration
  amnesh.soodar.soodar_interfaces:
    config:
      - name: ge2
        description: Configured and Merged by Ansible Network
        enabled: true
      - name: ge3
        description: Configured and Merged by Ansible Network
    state: merged

# Task Output
# -----------
#
# before:
# - enabled: true
#   name: ge1
# - description: Configured and Merged by Ansible Network
#   name: ge2
# - description: Configured and Merged by Ansible Network
#   name: ge3
# commands:
# - interface ge2
# - description Configured and Merged by Ansible Network
# - interface ge3
# - description Configured and Merged by Ansible Network
# after:
# - enabled: true
#   name: ge1
# - description: Configured and Merged by Ansible Network
#   enabled: true
#   name: ge2
# - description: Configured and Merged by Ansible Network
#   name: ge3

# After state:
# ------------
#
# Router# show running-config | section ^interface
# interface ge1
#  description Configured by Ansible
# interface ge2
#  description Configured and Merged by Ansible Network
# interface ge3
#  description Configured and Merged by Ansible Network

# Using replaced

# Before state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
# interface loopback999
#  no ip address
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  speed 1000
# interface ge3
#  no ip address
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
#  negotiation auto
# interface ge0.50
#  ip address dhcp

- name: Replaces device configuration of listed interfaces with provided configuration
  amnesh.soodar.soodar_interfaces:
    config:
      - name: ge3
        description: Configured and Replaced by Ansible Network
        enabled: false
        speed: 1000
    state: replaced

# Task Output
# -----------
#
# before:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: true
#   name: ge2
#   speed: '1000'
# - enabled: true
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: true
#   name: loopback888
# - enabled: true
#   name: loopback999
# - enabled: true
#   name: ge0.50
# commands:
# - interface ge3
# - description Configured and Replaced by Ansible Network
# - shutdown
# after:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: true
#   name: ge2
#   speed: '1000'
# - description: Configured and Replaced by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: true
#   name: loopback888
# - enabled: true
#   name: loopback999
# - enabled: true
#   name: ge0.50

# After state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
# interface loopback999
#  no ip address
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  speed 1000
# interface ge3
#  description Configured and Replaced by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
# interface ge0.50
#  ip address dhcp

# Using overridden

# Before state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
# interface loopback999
#  no ip address
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  speed 1000
# interface ge3
#  description Configured and Replaced by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
# interface ge0.50
#  ip address dhcp

- name: Override device configuration of all interfaces with provided configuration
  amnesh.soodar.soodar_interfaces:
    config:
      - description: Management interface do not change
        enabled: true
        name: ge1
      - name: ge2
        description: Configured and Overridden by Ansible Network
        speed: 10000
      - name: ge3
        description: Configured and Overridden by Ansible Network
        enabled: false
    state: overridden

# Task Output
# -----------
#
# before:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: true
#   name: ge2
#   speed: '1000'
# - description: Configured and Replaced by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: true
#   name: loopback888
# - enabled: true
#   name: loopback999
# - enabled: true
#   name: ge0.50
# commands:
# - interface loopback888
# - shutdown
# - interface loopback999
# - shutdown
# - interface ge0.50
# - shutdown
# - interface ge2
# - description Configured and Overridden by Ansible Network
# - speed 10000
# - interface ge3
# - description Configured and Overridden by Ansible Network
# - no speed 1000
# after:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - description: Configured and Overridden by Ansible Network
#   enabled: true
#   name: ge2
#   speed: '10000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback888
# - enabled: false
#   name: loopback999
# - enabled: false
#   name: ge0.50

# After state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
#  shutdown
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  description Configured and Overridden by Ansible Network
#  ip address dhcp
#  speed 10000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
# interface ge0.50
#  ip address dhcp hostname testHostname
#  shutdown

# Using Deleted

# Before state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
#  shutdown
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  description Configured and Overridden by Ansible Network
#  ip address dhcp
#  speed 10000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
# interface ge0.50
#  ip address dhcp hostname testHostname
#  shutdown

- name: "Delete interface attributes (Note: This won't delete the interface itself)"
  amnesh.soodar.soodar_interfaces:
    config:
      - name: ge2
    state: deleted

# Task Output
# -----------
#
# before:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - description: Configured and Overridden by Ansible Network
#   enabled: true
#   name: ge2
#   speed: '10000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback888
# - enabled: false
#   name: loopback999
# - enabled: false
#   name: ge0.50
# commands:
# - interface ge2
# - no description Configured and Overridden by Ansible Network
# - no speed 10000
# - shutdown
# after:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: false
#   name: ge2
#   speed: '1000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback888
# - enabled: false
#   name: loopback999
# - enabled: false
#   name: ge0.50

# After state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
#  shutdown
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
#  negotiation auto
# interface ge2
#  ip address dhcp
#  shutdown
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
#  no negotiation auto
# interface ge4
#  no ip address
#  shutdown
#  negotiation auto
# interface ge0.50
#  ip address dhcp
#  shutdown

# Using Purged

# Before state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback888
#  no ip address
#  shutdown
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  shutdown
#  speed 1000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown
# interface ge0.50
#  ip address dhcp
#  shutdown

- name: "Purge given interfaces (Note: This will delete the interface itself)"
  amnesh.soodar.soodar_interfaces:
    config:
      - name: loopback888
      - name: ge0.50
    state: purged

# Task Output
# -----------
#
# before:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: false
#   name: ge2
#   speed: '1000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback888
# - enabled: false
#   name: loopback999
# - enabled: false
#   name: ge0.50
# commands:
# - no interface loopback888
# - no interface ge0.50
# after:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: false
#   name: ge2
#   speed: '1000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback999

# After state:
# -------------
#
# Router# show running-config | section ^interface
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  shutdown
#  speed 1000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown

# Using gathered

# Before state:
# -------------
#
# Router# sh running-config | section ^interface
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  shutdown
#  speed 1000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown

- name: Gather facts of interfaces
  amnesh.soodar.soodar_interfaces:
    config:
    state: gathered

# Task Output
# -----------
#
# gathered:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: false
#   name: ge2
#   speed: '1000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback999

# Using rendered

- name: Render the commands for provided configuration
  amnesh.soodar.soodar_interfaces:
    config:
      - name: ge1
        description: Configured by Ansible-Network
        mtu: 110
        enabled: true
      - name: ge2
        description: Configured by Ansible-Network
        mtu: 2800
        enabled: false
        speed: 100
    state: rendered

# Task Output
# -----------
#
# rendered:
# - interface ge1
# - description Configured by Ansible-Network
# - mtu 110
# - no shutdown
# - interface ge2
# - description Configured by Ansible-Network
# - speed 100
# - mtu 2800
# - shutdown

# Using parsed

# File: parsed.cfg
# ----------------
#
# interface loopback999
#  no ip address
#  shutdown
# interface ge1
#  description Management interface do not change
#  ip address dhcp
# interface ge2
#  ip address dhcp
#  shutdown
#  speed 1000
# interface ge3
#  description Configured and Overridden by Ansible Network
#  no ip address
#  shutdown
#  speed 1000
# interface ge4
#  no ip address
#  shutdown

- name: Parse the provided configuration
  amnesh.soodar.soodar_interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task Output
# -----------
#
# parsed:
# - description: Management interface do not change
#   enabled: true
#   name: ge1
# - enabled: false
#   name: ge2
#   speed: '1000'
# - description: Configured and Overridden by Ansible Network
#   enabled: false
#   name: ge3
#   speed: '1000'
# - enabled: false
#   name: ge4
# - enabled: false
#   name: loopback999

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
after dictionary	The resulting configuration after module execution. Returned: when changed Sample: "This output will always be in the same format as the module argspec.\n"
before dictionary	The configuration prior to the module execution. Returned: when state is merged, replaced, overridden, deleted or purged Sample: "This output will always be in the same format as the module argspec.\n"
commands list / elements=string	The set of commands pushed to the remote device. Returned: when state is merged, replaced, overridden, deleted or purged Sample: ["sample command 1", "sample command 2", "sample command 3"]
gathered list / elements=string	Facts about the network resource gathered from the remote device as structured data. Returned: when state is gathered Sample: ["This output will always be in the same format as the module argspec.\n"]
parsed list / elements=string	The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is parsed Sample: ["This output will always be in the same format as the module argspec.\n"]
rendered list / elements=string	The provided configuration in the task rendered in device-native format (offline). Returned: when state is rendered Sample: ["sample command 1", "sample command 2", "sample command 3"]

Authors

• Sumit Jaiswal (@justjais)

• Sagar Paul (@KB-perByte)

• Mahdi Varasteh (@m-varasteh)

Collection links

• Issue Tracker
• Homepage