barrets2002 / barrets2002.smb / 0.0.1 / module / smb_interfaces Interfaces resource module | "added in version" 1.0.0 of barrets2002.smb" Authors: Sumit Jaiswal (@justjais)barrets2002.smb.smb_interfaces (0.0.1) — module
Install with ansible-galaxy collection install barrets2002.smb:==0.0.1
collections: - name: barrets2002.smb version: 0.0.1
This module manages the interface attributes of Cisco SMB network devices.
# Using merged # Before state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description This is test # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # no ip address # duplex auto # speed auto - name: Merge provided configuration with device configuration cisco.smb.smb_interfaces: config: - name: GigabitEthernet0/2 description: Configured and Merged by Ansible Network enabled: true - name: GigabitEthernet0/3 description: Configured and Merged by Ansible Network mtu: 2800 enabled: false speed: 100 duplex: full state: merged
# After state: # ------------ # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured and Merged by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured and Merged by Ansible Network # mtu 2800 # no ip address # shutdown # duplex full # speed 100 # Using replaced # Before state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # mtu 2000 # no ip address # shutdown # duplex full # speed 100 - name: Replaces device configuration of listed interfaces with provided configuration cisco.smb.smb_interfaces: config: - name: GigabitEthernet0/3 description: Configured and Replaced by Ansible Network enabled: false duplex: auto mtu: 2500 speed: 1000 state: replaced
# After state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured and Replaced by Ansible Network # mtu 2500 # no ip address # shutdown # duplex full # speed 1000 # Using overridden # Before state: # ------------- # # vsmb#show running-config | section ^interface# # interface GigabitEthernet0/1 # description Configured by Ansible # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description This is test # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured by Ansible # mtu 2800 # no ip address # shutdown # duplex full # speed 100 - name: Override device configuration of all interfaces with provided configuration cisco.smb.smb_interfaces: config: - name: GigabitEthernet0/2 description: Configured and Overridden by Ansible Network speed: 1000 - name: GigabitEthernet0/3 description: Configured and Overridden by Ansible Network enabled: false duplex: full mtu: 2000 state: overridden
# After state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured and Overridden by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured and Overridden by Ansible Network # mtu 2000 # no ip address # shutdown # duplex full # speed 100 # Using Deleted # Before state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured by Ansible Network # mtu 2500 # no ip address # shutdown # duplex full # speed 1000 - name: "Delete module attributes of given interfaces (Note: This won't delete the interface itself)" cisco.smb.smb_interfaces: config: - name: GigabitEthernet0/2 state: deleted
# After state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/3 # description Configured by Ansible Network # mtu 2500 # no ip address # shutdown # duplex full # speed 1000 # Using Deleted without any config passed #"(NOTE: This will delete all of configured resource module attributes from each configured interface)" # Before state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # description Configured by Ansible Network # no ip address # duplex auto # speed 1000 # interface GigabitEthernet0/3 # description Configured by Ansible Network # mtu 2500 # no ip address # shutdown # duplex full # speed 1000 - name: "Delete module attributes of all interfaces (Note: This won't delete the interface itself)" cisco.smb.smb_interfaces: state: deleted
# After state: # ------------- # # vsmb#show running-config | section ^interface # interface GigabitEthernet0/1 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/2 # no ip address # duplex auto # speed auto # interface GigabitEthernet0/3 # no ip address # duplex auto # speed auto # Using Gathered # Before state: # ------------- # # vsmb#sh running-config | section ^interface # interface GigabitEthernet0/1 # description this is interface1 # mtu 65 # duplex auto # speed 10 # interface GigabitEthernet0/2 # description this is interface2 # mtu 110 # shutdown # duplex auto # speed 100 - name: Gather listed interfaces with provided configurations cisco.smb.smb_interfaces: config: state: gathered
# Module Execution Result: # ------------------------ # # "gathered": [ # { # "description": "this is interface1", # "duplex": "auto", # "enabled": true, # "mtu": 65, # "name": "GigabitEthernet0/1", # "speed": "10" # }, # { # "description": "this is interface2", # "duplex": "auto", # "enabled": false, # "mtu": 110, # "name": "GigabitEthernet0/2", # "speed": "100" # } # ] # After state: # ------------ # # vsmb#sh running-config | section ^interface # interface GigabitEthernet0/1 # description this is interface1 # mtu 65 # duplex auto # speed 10 # interface GigabitEthernet0/2 # description this is interface2 # mtu 110 # shutdown # duplex auto # speed 100 # Using Rendered - name: Render the commands for provided configuration cisco.smb.smb_interfaces: config: - name: GigabitEthernet0/1 description: Configured by Ansible-Network mtu: 110 enabled: true duplex: half - name: GigabitEthernet0/2 description: Configured by Ansible-Network mtu: 2800 enabled: false speed: 100 duplex: full state: rendered
# Module Execution Result: # ------------------------ # # "rendered": [ # "interface GigabitEthernet0/1", # "description Configured by Ansible-Network", # "mtu 110", # "duplex half", # "no shutdown", # "interface GigabitEthernet0/2", # "description Configured by Ansible-Network", # "mtu 2800", # "speed 100", # "duplex full", # "shutdown" # Using Parsed # File: parsed.cfg # ---------------- # # interface GigabitEthernet0/1 # description interfaces 0/1 # mtu 110 # duplex half # no shutdown # interface GigabitEthernet0/2 # description interfaces 0/2 # mtu 2800 # speed 100 # duplex full # shutdown - name: Parse the commands for provided configuration cisco.smb.smb_interfaces: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed
state: choices: - merged - replaced - overridden - deleted - rendered - gathered - parsed default: merged description: - The state the configuration should be left in - The states I(rendered), I(gathered) and I(parsed) does not perform any change on the device. - The state I(rendered) will transform the configuration in C(config) option to platform specific CLI commands which will be returned in the I(rendered) key within the result. For state I(rendered) active connection to remote host is not required. - The state I(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 I(gathered) key within the result. - The state I(parsed) reads the configuration from C(running_config) option and transforms it into JSON format as per the resource module parameters and the value is returned in the I(parsed) key within the result. The value of C(running_config) option should be the same format as the output of command I(show running-config | include ip route|ipv6 route) executed on device. For state I(parsed) active connection to remote host is not required. type: str config: description: A dictionary of interface options elements: dict suboptions: description: description: - Interface description. type: str duplex: choices: - full - half - auto description: - Interface link status. Applicable for Ethernet interfaces only, either in half duplex, full duplex or in automatic state which negotiates the duplex automatically. type: str enabled: default: true description: - Administrative state of the interface. - Set the value to C(true) to administratively enable the interface or C(false) to disable it. type: bool mtu: description: - MTU for a specific interface. Applicable for Ethernet interfaces only. - Refer to vendor documentation for valid values. type: int name: description: - Full name of interface, e.g. GigabitEthernet0/2, loopback999. required: true type: str speed: description: - Interface link speed. Applicable for Ethernet interfaces only. type: str type: list running_config: description: - This option is used only with state I(parsed). - The value of this option should be the output received from the SMB device by executing the command B(show running-config | section ^interface). - The state I(parsed) reads the configuration from C(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 I(parsed) key within the result. type: str
after: description: The configuration as structured data after module completion. returned: when changed sample: The configuration returned will always be in the same format of the parameters above. type: list before: description: The configuration as structured data prior to module invocation. returned: always sample: The configuration returned will always be in the same format of the parameters above. type: list commands: description: The set of commands pushed to the remote device returned: always sample: - interface GigabitEthernet 0/1 - description This is test - speed 100 type: list