This integration enables the management of Cisco IOS Switches and Routers directly from XSOAR using Ansible modules. The Ansible engine is self-contained and pre-configured as part of this pack onto your XSOAR server, all you need to do is provide credentials you are ready to use the feature rich commands. This integration functions without any agents or additional software installed on the hosts by utilising SSH.

To use this integration, configure an instance of this integration. This will associate a credential to be used to access hosts when commands are run. The commands from this integration will take the IOS host address(es) as an input, and use the saved credential associated to the instance to execute. Create separate instances if multiple credentials are required.

Credentials

This integration supports a number of methods of authenticating with the network device:

1. Username & Password entered into the integration
2. Username & Password credential from the XSOAR credential manager
3. Username and SSH Key from the XSOAR credential manager

In addition to the SSH credential, a enable password must be also provided.

Permissions

The user account used for initial SSH login access can be level 1, however the enable password must also be provided.

Network Requirements

By default, TCP port 22 will be used to initiate a SSH connection to the IOS host.

The connection will be initiated from the XSOAR engine/server specified in the instance settings.

Configure Ansible Cisco IOS in Cortex

Testing

This integration does not support testing from the integration management screen. Instead it is recommended to use the !ios-factscommand providing an example host as the command argument. This command will connect to the specified network device with the configured credentials in the integration, and if successful output general information about the device.

Idempotence

The action commands in this integration are idempotent. This means that the result of performing it once is exactly the same as the result of performing it repeatedly without any intervening actions.

State Arguement

Some of the commands in this integration take a state argument. These define the desired end state of the object being managed. As a result these commands are able to perform multiple management operations depending on the desired state value. Common state values are:

Complex Command Inputs

Some commands may require structured input arguments such as lists or dictionary, these can be provided in standard JSON notation wrapped in double curly braces. For example a argument called dns_servers that accepts a list of server IPs 8.8.8.8 and 8.8.4.4 would be entered as dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}".

Other more advanced data manipulation tools such as Ansible/Jinja2 filters can also be used in-line. For example to get a random number between 0 and 60 you can use {{ 60 | random }}.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

ios-banner

Manage multiline banners on Cisco IOS devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_banner_module.html

Base Command

ios-banner

Input

Context Output

Command Example

!ios-banner host="123.123.123.123" banner="login" text="this is my login banner" state="present"

Context Example

{
    "CiscoIOS": {
        "IosBanner": {
            "changed": true,
            "commands": [
                "banner login @\nthis is my login banner\n@"
            ],
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Commands

  • 0: banner login @
    this is my login banner
    @

ios-bgp

Configure global BGP protocol settings on Cisco IOS.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_bgp_module.html

Base Command

ios-bgp

Input

Context Output

Command Example

!ios-bgp host="123.123.123.123" config="{{ {'bgp_as': 64496, 'router_id': '192.0.2.1', 'log_neighbor_changes': True, 'neighbors': [{'neighbor': '1.1.1.1', 'remote_as': 64511, 'timers': {'keepalive': 300, 'holdtime': 360, 'min_neighbor_holdtime': 360}}, {'neighbor': '1.1.1.2', 'remote_as': 64498}], 'networks': [{'prefix': '198.51.100.0', 'route_map': 'RMAP_1'}, {'prefix': '192.0.2.0', 'masklen': 23}], 'address_family': [{'afi': 'ipv4', 'safi': 'unicast', 'redistribute': [{'protocol': 'ospf', 'id': 223, 'metric': 10}]}]} }}" operation="merge"

Context Example

{
    "CiscoIOS": {
        "IosBgp": {
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Commands

ios-command

Run commands on remote devices running Cisco IOS
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_command_module.html

Base Command

ios-command

Input

Context Output

Command Example

!ios-command host="123.123.123.123" commands="show version"

Context Example

{
    "CiscoIOS": {
        "IosCommand": {
            "changed": false,
            "host": "123.123.123.123",
            "status": "SUCCESS",
            "stdout": [
                "Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.7(3)M3, RELEASE SOFTWARE (fc2)\nTechnical Support: http://www.cisco.com/techsupport\nCopyright (c) 1986-2018 by TestNet Systems, Inc.\nCompiled Wed 01-Aug-18 16:45 by prod_rel_team\n\n\nROM: Bootstrap program is IOSv\n\nIOSv01 uptime is 1 hour, 33 minutes\nSystem returned to ROM by reload\nSystem image file is \"flash0:/vios-adventerprisek9-m\"\nLast reload reason: Unknown reason\n\n\n\nThis product contains cryptographic features and is subject to United\nStates and local country laws governing import, export, transfer and\nuse. Delivery of Cisco cryptographic products does not imply\nthird-party authority to import, export, distribute or use encryption.\nImporters, exporters, distributors and users are responsible for\ncompliance with U.S. and local country laws. By using this product you\nagree to comply with applicable laws and regulations. If you are unable\nto comply with U.S. and local laws, return this product immediately.\n\nA summary of U.S. laws governing Cisco cryptographic products may be found at:\nhttp://www.cisco.com/wwl/export/crypto/tool/stqrg.html\n\nIf you require further assistance please contact us by sending email to\nexport@cisco.com.\n\nCisco IOSv (revision 1.0) with  with 460009K/62464K bytes of memory.\nProcessor board ID XXXX\n4 Gigabit Ethernet interfaces\nDRAM configuration is 72 bits wide with parity disabled.\n256K bytes of non-volatile configuration memory.\n2097152K bytes of ATA System CompactFlash 0 (Read/Write)\n0K bytes of ATA CompactFlash 1 (Read/Write)\n1024K bytes of ATA CompactFlash 2 (Read/Write)\n0K bytes of ATA CompactFlash 3 (Read/Write)\n\n\n\nConfiguration register is 0x0"
            ],
            "stdout_lines": [
                [
                    "Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.7(3)M3, RELEASE SOFTWARE (fc2)",
                    "Technical Support: http://www.cisco.com/techsupport",
                    "Copyright (c) 1986-2018 by TestNet Systems, Inc.",
                    "Compiled Wed 01-Aug-18 16:45 by prod_rel_team",
                    "",
                    "",
                    "ROM: Bootstrap program is IOSv",
                    "",
                    "IOSv01 uptime is 1 hour, 33 minutes",
                    "System returned to ROM by reload",
                    "System image file is \"flash0:/vios-adventerprisek9-m\"",
                    "Last reload reason: Unknown reason",
                    "",
                    "",
                    "",
                    "This product contains cryptographic features and is subject to United",
                    "States and local country laws governing import, export, transfer and",
                    "use. Delivery of Cisco cryptographic products does not imply",
                    "third-party authority to import, export, distribute or use encryption.",
                    "Importers, exporters, distributors and users are responsible for",
                    "compliance with U.S. and local country laws. By using this product you",
                    "agree to comply with applicable laws and regulations. If you are unable",
                    "to comply with U.S. and local laws, return this product immediately.",
                    "",
                    "A summary of U.S. laws governing Cisco cryptographic products may be found at:",
                    "http://www.cisco.com/wwl/export/crypto/tool/stqrg.html",
                    "",
                    "If you require further assistance please contact us by sending email to",
                    "export@cisco.com.",
                    "",
                    "Cisco IOSv (revision 1.0) with  with 460009K/62464K bytes of memory.",
                    "Processor board ID XXXX",
                    "4 Gigabit Ethernet interfaces",
                    "DRAM configuration is 72 bits wide with parity disabled.",
                    "256K bytes of non-volatile configuration memory.",
                    "2097152K bytes of ATA System CompactFlash 0 (Read/Write)",
                    "0K bytes of ATA CompactFlash 1 (Read/Write)",
                    "1024K bytes of ATA CompactFlash 2 (Read/Write)",
                    "0K bytes of ATA CompactFlash 3 (Read/Write)",
                    "",
                    "",
                    "",
                    "Configuration register is 0x0"
                ]
            ]
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Stdout

  • 0: Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.7(3)M3, RELEASE SOFTWARE (fc2)
    Technical Support: http://www.cisco.com/techsupport
    Copyright (c) 1986-2018 by TestNet Systems, Inc.
    Compiled Wed 01-Aug-18 16:45 by prod_rel_team

ROM: Bootstrap program is IOSv

IOSv01 uptime is 1 hour, 33 minutes
System returned to ROM by reload
System image file is “flash0:/vios-adventerprisek9-m”
Last reload reason: Unknown reason

This product contains cryptographic features and is subject to United
States and local country laws governing import, export, transfer and
use. Delivery of Cisco cryptographic products does not imply
third-party authority to import, export, distribute or use encryption.
Importers, exporters, distributors and users are responsible for
compliance with U.S. and local country laws. By using this product you
agree to comply with applicable laws and regulations. If you are unable
to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at:
http://www.cisco.com/wwl/export/crypto/tool/stqrg.html

If you require further assistance please contact us by sending email to
export@cisco.com.

Cisco IOSv (revision 1.0) with with 460009K/62464K bytes of memory.
Processor board ID XXXX
4 Gigabit Ethernet interfaces
DRAM configuration is 72 bits wide with parity disabled.
256K bytes of non-volatile configuration memory.
2097152K bytes of ATA System CompactFlash 0 (Read/Write)
0K bytes of ATA CompactFlash 1 (Read/Write)
1024K bytes of ATA CompactFlash 2 (Read/Write)
0K bytes of ATA CompactFlash 3 (Read/Write)

Configuration register is 0x0

• Stdout_Lines

• List

  • 0: Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.7(3)M3, RELEASE SOFTWARE (fc2)
  • 1: Technical Support: http://www.cisco.com/techsupport
  • 2: Copyright (c) 1986-2018 by TestNet Systems, Inc.
  • 3: Compiled Wed 01-Aug-18 16:45 by prod_rel_team
  • 4:
  • 4:
  • 6: ROM: Bootstrap program is IOSv
  • 4:
  • 8: IOSv01 uptime is 1 hour, 33 minutes
  • 9: System returned to ROM by reload
  • 10: System image file is “flash0:/vios-adventerprisek9-m”
  • 11: Last reload reason: Unknown reason
  • 4:
  • 4:
  • 4:
  • 15: This product contains cryptographic features and is subject to United
  • 16: States and local country laws governing import, export, transfer and
  • 17: use. Delivery of Cisco cryptographic products does not imply
  • 18: third-party authority to import, export, distribute or use encryption.
  • 19: Importers, exporters, distributors and users are responsible for
  • 20: compliance with U.S. and local country laws. By using this product you
  • 21: agree to comply with applicable laws and regulations. If you are unable
  • 22: to comply with U.S. and local laws, return this product immediately.
  • 4:
  • 24: A summary of U.S. laws governing Cisco cryptographic products may be found at:
  • 25: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html
  • 4:
  • 27: If you require further assistance please contact us by sending email to
  • 28: export@cisco.com.
  • 4:
  • 30: Cisco IOSv (revision 1.0) with with 460009K/62464K bytes of memory.
  • 31: Processor board ID XXXX
  • 32: 4 Gigabit Ethernet interfaces
  • 33: DRAM configuration is 72 bits wide with parity disabled.
  • 34: 256K bytes of non-volatile configuration memory.
  • 35: 2097152K bytes of ATA System CompactFlash 0 (Read/Write)
  • 36: 0K bytes of ATA CompactFlash 1 (Read/Write)
  • 37: 1024K bytes of ATA CompactFlash 2 (Read/Write)
  • 38: 0K bytes of ATA CompactFlash 3 (Read/Write)
  • 4:
  • 4:
  • 4:
  • 42: Configuration register is 0x0

ios-config

Manage Cisco IOS configuration sections
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_config_module.html

Base Command

ios-config

Input

Context Output

Command Example

!ios-config host="123.123.123.123" lines="hostname IOSv01" backup="yes"

Context Example

{
    "CiscoIOS": {
        "IosConfig": {
            "backup_path": "./backup/123.123.123.123_config.2021-07-11@09:08:02",
            "changed": true,
            "date": "2021-07-11",
            "filename": "123.123.123.123_config.2021-07-11@09:08:02",
            "host": "123.123.123.123",
            "shortname": "./backup/123.123.123.123_config",
            "status": "CHANGED",
            "time": "09:08:02"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• backup_path: ./backup/123.123.123.123_config.2021-07-11@09:08:02
• changed: True
• date: 2021-07-11
• filename: 123.123.123.123_config.2021-07-11@09:08:02
• shortname: ./backup/123.123.123.123_config
• time: 09:08:02

ios-facts

Collect facts from remote devices running Cisco IOS
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_facts_module.html

Base Command

ios-facts

Input

Context Output

Command Example

!ios-facts host="123.123.123.123" gather_subset="all"

Context Example

{
    "CiscoIOS": {
        "IosFacts": {
            "discovered_interpreter_python": "/usr/local/bin/python",
            "host": "123.123.123.123",
            "net_all_ipv4_addresses": [
                "123.123.123.123",
                "192.168.0.2"
            ],
            "net_all_ipv6_addresses": [
                "1:11:11:11"
            ],
            "net_api": "cliconf",
            "net_config": "!\n! Last configuration change at 08:56:26 UTC Sun Jul 11 2021 by admin\n!\nversion 15.7\nservice timestamps debug datetime msec\nservice timestamps log datetime msec\nno service password-encryption\n!\nhostname IOSv01\n!\nboot-start-marker\nboot-end-marker\n!\n!\nenable secret 5 $1$abcdefghijklmnopqrstuvwxyz.\n!\nno aaa new-model\n!\n!\n!\nmmi polling-interval 60\nno mmi auto-configure\nno mmi pvc\nmmi snmp-timeout 180\n!\n!\n!\n!\n!\nno ip icmp rate-limit unreachable\n!\n!\n!\n!\n!\n!\nip domain list ansible.com\nip domain list redhat.com\nip domain list cisco.com\nno ip domain lookup\nip domain name test.example.com\nip cef\nno ipv6 cef\n!\nmultilink bundle-name authenticated\n!\n!\n!\n!\nusername admin password 0 abcdef\nusername ansible nopassword\n!\nredundancy\n!\nlldp timer 10\nlldp holdtime 10\nlldp reinit 3\nlldp run\nno cdp log mismatch duplex\n!\nip tcp synwait-time 5\n! \n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\ninterface GigabitEthernet0/0\n ip address 123.123.123.123 255.255.255.0\n duplex auto\n speed auto\n media-type rj45\n!\ninterface GigabitEthernet0/1\n no ip address\n shutdown\n duplex auto\n speed auto\n media-type rj45\n!\ninterface GigabitEthernet0/2\n description Configured and Merged by Ansible Network\n ip address 192.168.0.2 255.255.255.0\n duplex auto\n speed auto\n media-type rj45\n!\ninterface GigabitEthernet0/3\n description Configured and Merged by Ansible Network\n mtu 2800\n no ip address\n shutdown\n duplex full\n speed 100\n media-type rj45\n ipv6 address 1:11:11:11/64\n!\ninterface GigabitEthernet0/3.100\n!\nrouter bgp 64496\n bgp router-id 192.0.2.1\n bgp log-neighbor-changes\n neighbor 1.1.1.2 remote-as 64498\n neighbor 1.1.1.1 remote-as 64511\n neighbor 1.1.1.1 timers 300 360 360\n !\n address-family ipv4\n  network 192.0.2.0 mask 255.255.254.0\n  network 198.51.100.0 route-map RMAP_1\n  redistribute ospf 223 metric 10\n  neighbor 1.1.1.2 activate\n  neighbor 1.1.1.1 activate\n exit-address-family\n!\nip default-gateway 192.168.1.1\nip forward-protocol nd\n!\n!\nno ip http server\nno ip http secure-server\nip route 192.168.2.0 255.255.255.0 10.0.0.1\nip ssh version 2\nip ssh pubkey-chain\n  username ansible\n   key-hash ssh-rsa B1E29F17C950E2FEAB5BC3AC2A760208 \nip ssh server algorithm mac hmac-sha2-256\n!\nlogging host 172.16.0.1\nipv6 ioam timestamp\n!\n!\n!\ncontrol-plane\n!\nbanner exec ^C\n**************************************************************************\n* IOSv is strictly limited to use for evaluation, demonstration and IOS  *\n* education. IOSv is provided as-is and is not supported by Cisco's      *\n* Technical Advisory Center. Any use or disclosure, in whole or in part, *\n* of the IOSv Software or Documentation to any third party for any       *\n* purposes is expressly prohibited except as otherwise authorized by     *\n* Cisco in writing.                                                      *\n**************************************************************************^C\nbanner incoming ^C\n**************************************************************************\n* IOSv is strictly limited to use for evaluation, demonstration and IOS  *\n* education. IOSv is provided as-is and is not supported by Cisco's      *\n* Technical Advisory Center. Any use or disclosure, in whole or in part, *\n* of the IOSv Software or Documentation to any third party for any       *\n* purposes is expressly prohibited except as otherwise authorized by     *\n* Cisco in writing.                                                      *\n**************************************************************************^C\nbanner login ^C\nthis is my login banner\n^C\n!\nline con 0\n exec-timeout 0 0\n privilege level 15\n logging synchronous\nline aux 0\n exec-timeout 0 0\n privilege level 15\n logging synchronous\nline vty 0 4\n login local\n transport input ssh\n!\nno scheduler allocate\nntp server 1.1.1.3\n!\nend",
            "net_filesystems": [
                "flash0:"
            ],
            "net_filesystems_info": {
                "flash0:": {
                    "spacefree_kb": 1941968,
                    "spacetotal_kb": 2092496
                }
            },
            "net_gather_network_resources": [],
            "net_gather_subset": [
                "interfaces",
                "default",
                "hardware",
                "config"
            ],
            "net_hostname": "IOSv01",
            "net_image": "flash0:/vios-adventerprisek9-m",
            "net_interfaces": {
                "GigabitEthernet0/0": {
                    "bandwidth": 1000000,
                    "description": null,
                    "duplex": "Auto",
                    "ipv4": [
                        {
                            "address": "123.123.123.123",
                            "subnet": "24"
                        }
                    ],
                    "lineprotocol": "up",
                    "macaddress": "0c05.2bf9.3e00",
                    "mediatype": "RJ45",
                    "mtu": 1500,
                    "operstatus": "up",
                    "type": "iGbE"
                },
                "GigabitEthernet0/1": {
                    "bandwidth": 1000000,
                    "description": null,
                    "duplex": "Auto",
                    "ipv4": [],
                    "lineprotocol": "down",
                    "macaddress": "0c05.2bf9.3e01",
                    "mediatype": "RJ45",
                    "mtu": 1500,
                    "operstatus": "administratively down",
                    "type": "iGbE"
                },
                "GigabitEthernet0/2": {
                    "bandwidth": 1000000,
                    "description": "Configured and Merged by Ansible Network",
                    "duplex": "Auto",
                    "ipv4": [
                        {
                            "address": "192.168.0.2",
                            "subnet": "24"
                        }
                    ],
                    "lineprotocol": "down",
                    "macaddress": "0c05.2bf9.3e02",
                    "mediatype": "RJ45",
                    "mtu": 1500,
                    "operstatus": "down",
                    "type": "iGbE"
                },
                "GigabitEthernet0/3": {
                    "bandwidth": 100000,
                    "description": "Configured and Merged by Ansible Network",
                    "duplex": "Full",
                    "ipv4": [],
                    "ipv6": [
                        {
                            "address": "1:11:11:11",
                            "subnet": "11:11:11:11:11:11:11:11/64 [TEN]"
                        }
                    ],
                    "lineprotocol": "down",
                    "macaddress": "0c05.2bf9.3e03",
                    "mediatype": "RJ45",
                    "mtu": 2800,
                    "operstatus": "administratively down",
                    "type": "iGbE"
                },
                "GigabitEthernet0/3.100": {
                    "bandwidth": 100000,
                    "description": null,
                    "duplex": null,
                    "ipv4": [],
                    "lineprotocol": "down",
                    "macaddress": "0c05.2bf9.3e03",
                    "mediatype": null,
                    "mtu": 2800,
                    "operstatus": "administratively down",
                    "type": "iGbE"
                }
            },
            "net_iostype": "IOS",
            "net_memfree_mb": 244233.24609375,
            "net_memtotal_mb": 310087.16796875,
            "net_model": "IOSv",
            "net_neighbors": {},
            "net_python_version": "3.9.5",
            "net_serialnum": "XXXX",
            "net_system": "ios",
            "net_version": "15.7(3)M3",
            "network_resources": {},
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• net_api: cliconf
• net_config: !
  ! Last configuration change at 08:56:26 UTC Sun Jul 11 2021 by admin
  !
  version 15.7
  service timestamps debug datetime msec
  service timestamps log datetime msec
  no service password-encryption
  !
  hostname IOSv01
  !
  boot-start-marker
  boot-end-marker
  !
  !
  enable secret 5 $1$abcdefghijklmnopqrstuvwxyz.
  !
  no aaa new-model
  !
  !
  !
  mmi polling-interval 60
  no mmi auto-configure
  no mmi pvc
  mmi snmp-timeout 180
  !
  no ip icmp rate-limit unreachable
  !
  ip domain list ansible.com
  ip domain list redhat.com
  ip domain list cisco.com
  no ip domain lookup
  ip domain name test.example.com
  ip cef
  no ipv6 cef
  !
  multilink bundle-name authenticated
  !
  !
  !
  !
  username admin password 0 abcdef
  username ansible nopassword
  !
  redundancy
  !
  lldp timer 10
  lldp holdtime 10
  lldp reinit 3
  lldp run
  no cdp log mismatch duplex
  !
  ip tcp synwait-time 5
  !
  interface GigabitEthernet0/0
  ip address 123.123.123.123 255.255.255.0
  duplex auto
  speed auto
  media-type rj45
  !
  interface GigabitEthernet0/1
  no ip address
  shutdown
  duplex auto
  speed auto
  media-type rj45
  !
  interface GigabitEthernet0/2
  description Configured and Merged by Ansible Network
  ip address 192.168.0.2 255.255.255.0
  duplex auto
  speed auto
  media-type rj45
  !
  interface GigabitEthernet0/3
  description Configured and Merged by Ansible Network
  mtu 2800
  no ip address
  shutdown
  duplex full
  speed 100
  media-type rj45
  ipv6 address 1:11:11:11/64
  !
  interface GigabitEthernet0/3.100
  !
  router bgp 64496
  bgp router-id 192.0.2.1
  bgp log-neighbor-changes
  neighbor 1.1.1.2 remote-as 64498
  neighbor 1.1.1.1 remote-as 64511
  neighbor 1.1.1.1 timers 300 360 360
  !
  address-family ipv4
  network 192.0.2.0 mask 255.255.254.0
  network 198.51.100.0 route-map RMAP_1
  redistribute ospf 223 metric 10
  neighbor 1.1.1.2 activate
  neighbor 1.1.1.1 activate
  exit-address-family
  !
  ip default-gateway 192.168.1.1
  ip forward-protocol nd
  !
  !
  no ip http server
  no ip http secure-server
  ip route 192.168.2.0 255.255.255.0 10.0.0.1
  ip ssh version 2
  ip ssh pubkey-chain
  username ansible
  key-hash ssh-rsa B1E29F17C950E2FEAB5BC3AC2A760208
  ip ssh server algorithm mac hmac-sha2-256
  !
  logging host 172.16.0.1
  ipv6 ioam timestamp
  !
  !
  !
  control-plane
  !
  banner exec ^C

---

• IOSv is strictly limited to use for evaluation, demonstration and IOS *
• education. IOSv is provided as-is and is not supported by Cisco’s *
• Technical Advisory Center. Any use or disclosure, in whole or in part, *
• of the IOSv Software or Documentation to any third party for any *
• purposes is expressly prohibited except as otherwise authorized by *
• Cisco in writing. *
  **************************^C
  banner incoming ^C

---

• IOSv is strictly limited to use for evaluation, demonstration and IOS *
• education. IOSv is provided as-is and is not supported by Cisco’s *
• Technical Advisory Center. Any use or disclosure, in whole or in part, *
• of the IOSv Software or Documentation to any third party for any *
• purposes is expressly prohibited except as otherwise authorized by *
• Cisco in writing. *
  **************************^C
  banner login ^C
  this is my login banner
  ^C
  !
  line con 0
  exec-timeout 0 0
  privilege level 15
  logging synchronous
  line aux 0
  exec-timeout 0 0
  privilege level 15
  logging synchronous
  line vty 0 4
  login local
  transport input ssh
  !
  no scheduler allocate
  ntp server 1.1.1.3
  !
  end
  • net_hostname: IOSv01
  • net_image: flash0:/vios-adventerprisek9-m
  • net_iostype: IOS
  • net_memfree_mb: 244233.24609375
  • net_memtotal_mb: 310087.16796875
  • net_model: IOSv
  • net_python_version: 3.9.5
  • net_serialnum: XXXX
  • net_system: ios
  • net_version: 15.7(3)M3
  • discovered_interpreter_python: /usr/local/bin/python

    • Net_All_Ipv4_Addresses

• 0: 123.123.123.123
• 1: 192.168.0.2

  • Net_All_Ipv6_Addresses

• 0: 1:11:11:11

• Net_Filesystems>

• 0: flash0:

  • Net_Filesystems_Info

• Flash0

  • spacefree_kb: 1941968.0
  • spacetotal_kb: 2092496.0

    • Net_Gather_Network_Resources

    • Net_Gather_Subset

• 0: interfaces
• 1: default
• 2: hardware
• 3: config

  • Net_Interfaces

• Gigabitethernet0/0

  • bandwidth: 1000000
  • description: None
  • duplex: Auto
  • lineprotocol: up
  • macaddress: 0c05.2bf9.3e00
  • mediatype: RJ45
  • mtu: 1500
  • operstatus: up

  • type: iGbE

  • Ipv4

  • List

    • address: 123.123.123.123
    • subnet: 24

• Gigabitethernet0/1

  • bandwidth: 1000000
  • description: None
  • duplex: Auto
  • lineprotocol: down
  • macaddress: 0c05.2bf9.3e01
  • mediatype: RJ45
  • mtu: 1500
  • operstatus: administratively down

  • type: iGbE

  • Ipv4

• Gigabitethernet0/2

  • bandwidth: 1000000
  • description: Configured and Merged by Ansible Network
  • duplex: Auto
  • lineprotocol: down
  • macaddress: 0c05.2bf9.3e02
  • mediatype: RJ45
  • mtu: 1500
  • operstatus: down

  • type: iGbE

  • Ipv4

  • List

    • address: 192.168.0.2
    • subnet: 24

• Gigabitethernet0/3

  • bandwidth: 100000
  • description: Configured and Merged by Ansible Network
  • duplex: Full
  • lineprotocol: down
  • macaddress: 0c05.2bf9.3e03
  • mediatype: RJ45
  • mtu: 2800
  • operstatus: administratively down

  • type: iGbE

  • Ipv4

  • Ipv6

  • List

    • address: 1:11:11:11
    • subnet: 11:11:11:11:11:11:11:11/64 [TEN]

• Gigabitethernet0/3.100

  • bandwidth: 100000
  • description: None
  • duplex: None
  • lineprotocol: down
  • macaddress: 0c05.2bf9.3e03
  • mediatype: None
  • mtu: 2800
  • operstatus: administratively down

  • type: iGbE

  • Ipv4

• Net_Neighbors>

• Network_Resources

ios-interfaces

Manages interface attributes of Cisco IOS network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_interfaces_module.html

Base Command

ios-interfaces

Input

Context Output

Command Example

!ios-interfaces host="123.123.123.123" 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"

Context Example

{
    "CiscoIOS": {
        "IosInterfaces": {
            "before": [
                {
                    "duplex": "auto",
                    "enabled": true,
                    "name": "GigabitEthernet0/0",
                    "speed": "auto"
                },
                {
                    "duplex": "auto",
                    "enabled": false,
                    "name": "GigabitEthernet0/1",
                    "speed": "auto"
                },
                {
                    "description": "Configured and Merged by Ansible Network",
                    "duplex": "auto",
                    "enabled": true,
                    "name": "GigabitEthernet0/2",
                    "speed": "auto"
                },
                {
                    "description": "Configured and Merged by Ansible Network",
                    "duplex": "full",
                    "enabled": false,
                    "mtu": 2800,
                    "name": "GigabitEthernet0/3",
                    "speed": "100"
                },
                {
                    "enabled": true,
                    "name": "GigabitEthernet0/3.100"
                }
            ],
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Before

• Gigabitethernet0/0

  • duplex: auto
  • enabled: True
  • name: GigabitEthernet0/0
  • speed: auto

• Gigabitethernet0/1

  • duplex: auto
  • enabled: False
  • name: GigabitEthernet0/1
  • speed: auto

• Gigabitethernet0/2

  • description: Configured and Merged by Ansible Network
  • duplex: auto
  • enabled: True
  • name: GigabitEthernet0/2
  • speed: auto

• Gigabitethernet0/3

  • description: Configured and Merged by Ansible Network
  • duplex: full
  • enabled: False
  • mtu: 2800
  • name: GigabitEthernet0/3
  • speed: 100

• Gigabitethernet0/3.100

  • enabled: True
  • name: GigabitEthernet0/3.100

• Commands

ios-l2-interfaces

Manage Layer-2 interface on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_l2_interfaces_module.html

Base Command

ios-l2-interfaces

Input

Context Output

ios-l3-interfaces

Manage Layer-3 interface on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_l3_interfaces_module.html

Base Command

ios-l3-interfaces

Input

Context Output

Command Example

!ios-l3-interfaces host="123.123.123.123" config="{{ [{'name': 'GigabitEthernet0/3', 'ipv4': [{'address': '192.168.0.1/24', 'secondary': True}]}, {'name': 'GigabitEthernet0/2', 'ipv4': [{'address': '192.168.0.2/24'}]}, {'name': 'GigabitEthernet0/3', 'ipv6': [{'address': '1:11:11:11/64'}]}, {'name': 'GigabitEthernet0/3.100', 'ipv4': [{'address': '192.168.0.3/24'}]}] }}" state="merged"

Context Example

{
    "CiscoIOS": {
        "IosL3Interfaces": {
            "after": [
                {
                    "ipv4": [
                        {
                            "address": "123.123.123.123 255.255.255.0"
                        }
                    ],
                    "name": "GigabitEthernet0/0"
                },
                {
                    "name": "GigabitEthernet0/1"
                },
                {
                    "ipv4": [
                        {
                            "address": "192.168.0.2 255.255.255.0"
                        }
                    ],
                    "name": "GigabitEthernet0/2"
                },
                {
                    "ipv6": [
                        {
                            "address": "1:11:11:11/64"
                        }
                    ],
                    "name": "GigabitEthernet0/3"
                },
                {
                    "name": "GigabitEthernet0/3.100"
                }
            ],
            "before": [
                {
                    "ipv4": [
                        {
                            "address": "123.123.123.123 255.255.255.0"
                        }
                    ],
                    "name": "GigabitEthernet0/0"
                },
                {
                    "name": "GigabitEthernet0/1"
                },
                {
                    "ipv4": [
                        {
                            "address": "192.168.0.2 255.255.255.0"
                        }
                    ],
                    "name": "GigabitEthernet0/2"
                },
                {
                    "ipv6": [
                        {
                            "address": "1:11:11:11/64"
                        }
                    ],
                    "name": "GigabitEthernet0/3"
                },
                {
                    "name": "GigabitEthernet0/3.100"
                }
            ],
            "changed": true,
            "commands": [
                "interface GigabitEthernet0/3",
                "ip address 192.168.0.1 255.255.255.0 secondary",
                "interface GigabitEthernet0/3.100",
                "ip address 192.168.0.3 255.255.255.0"
            ],
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• After

• Gigabitethernet0/0

  • name: GigabitEthernet0/0

  • Ipv4

  • List

    • address: 123.123.123.123 255.255.255.0

• Gigabitethernet0/1

  • name: GigabitEthernet0/1

• Gigabitethernet0/2

  • name: GigabitEthernet0/2

  • Ipv4

  • List

    • address: 192.168.0.2 255.255.255.0

• Gigabitethernet0/3

  • name: GigabitEthernet0/3

  • Ipv6

  • List

    • address: 1:11:11:11/64

• Gigabitethernet0/3.100

  • name: GigabitEthernet0/3.100

• Before

• Gigabitethernet0/0

  • name: GigabitEthernet0/0

  • Ipv4

  • List

    • address: 123.123.123.123 255.255.255.0

• Gigabitethernet0/1

  • name: GigabitEthernet0/1

• Gigabitethernet0/2

  • name: GigabitEthernet0/2

  • Ipv4

  • List

    • address: 192.168.0.2 255.255.255.0

• Gigabitethernet0/3

  • name: GigabitEthernet0/3

  • Ipv6

  • List

    • address: 1:11:11:11/64

• Gigabitethernet0/3.100

  • name: GigabitEthernet0/3.100

• Commands

  • 0: interface GigabitEthernet0/3
  • 1: ip address 192.168.0.1 255.255.255.0 secondary
  • 2: interface GigabitEthernet0/3.100
  • 3: ip address 192.168.0.3 255.255.255.0

ios-lacp

Manage Global Link Aggregation Control Protocol (LACP) on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lacp_module.html

Base Command

ios-lacp

Input

Context Output

ios-lacp-interfaces

Manage Link Aggregation Control Protocol (LACP) on Cisco IOS devices interface.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lacp_interfaces_module.html

Base Command

ios-lacp-interfaces

Input

Context Output

ios-lag-interfaces

Manage Link Aggregation on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lag_interfaces_module.html

Base Command

ios-lag-interfaces

Input

Context Output

ios-linkagg

Manage link aggregation groups on Cisco IOS network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_linkagg_module.html

Base Command

ios-linkagg

Input

Context Output

ios-lldp

Manage LLDP configuration on Cisco IOS network devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lldp_module.html

Base Command

ios-lldp

Input

Context Output

Command Example

!ios-lldp host="123.123.123.123" state="present"

Context Example

{
    "CiscoIOS": {
        "IosLldp": {
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Commands

ios-lldp-global

Configure and manage Link Layer Discovery Protocol(LLDP) attributes on IOS platforms.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lldp_global_module.html

Base Command

ios-lldp-global

Input

Context Output

Command Example

!ios-lldp-global host="123.123.123.123" config="{{ {'holdtime': 10, 'enabled': True, 'reinit': 3, 'timer': 10} }}" state="merged"

Context Example

{
    "CiscoIOS": {
        "IosLldpGlobal": {
            "before": {
                "enabled": true,
                "holdtime": 10,
                "reinit": 3,
                "timer": 10
            },
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Before

  • enabled: True
  • holdtime: 10
  • reinit: 3
  • timer: 10

• Commands

ios-lldp-interfaces

Manage link layer discovery protocol (LLDP) attributes of interfaces on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_lldp_interfaces_module.html

Base Command

ios-lldp-interfaces

Input

Context Output

Command Example

!ios-lldp-interfaces host="123.123.123.123" config="{{ [{'name': 'GigabitEthernet0/1', 'receive': True, 'transmit': True}, {'name': 'GigabitEthernet0/2', 'receive': True}, {'name': 'GigabitEthernet0/3', 'transmit': True}] }}" state="merged"

Context Example

{
    "CiscoIOS": {
        "IosLldpInterfaces": {
            "before": [
                {
                    "name": "GigabitEthernet0/0",
                    "receive": true,
                    "transmit": true
                },
                {
                    "name": "GigabitEthernet0/1",
                    "receive": true,
                    "transmit": true
                },
                {
                    "name": "GigabitEthernet0/2",
                    "receive": true,
                    "transmit": true
                },
                {
                    "name": "GigabitEthernet0/3",
                    "receive": true,
                    "transmit": true
                },
                {
                    "name": "GigabitEthernet0/3.100",
                    "receive": true,
                    "transmit": true
                }
            ],
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Before

• Gigabitethernet0/0

  • name: GigabitEthernet0/0
  • receive: True
  • transmit: True

• Gigabitethernet0/1

  • name: GigabitEthernet0/1
  • receive: True
  • transmit: True

• Gigabitethernet0/2

  • name: GigabitEthernet0/2
  • receive: True
  • transmit: True

• Gigabitethernet0/3

  • name: GigabitEthernet0/3
  • receive: True
  • transmit: True

• Gigabitethernet0/3.100

  • name: GigabitEthernet0/3.100
  • receive: True
  • transmit: True

• Commands

ios-logging

Manage logging on network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_logging_module.html

Base Command

ios-logging

Input

Context Output

Command Example

!ios-logging host="123.123.123.123" dest="host" name="172.16.0.1" state="present"

Context Example

{
    "CiscoIOS": {
        "IosLogging": {
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Commands

ios-ntp

Manages core NTP configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_ntp_module.html

Base Command

ios-ntp

Input

Context Output

Command Example

!ios-ntp host="123.123.123.123" server="1.1.1.3" source_int="GigabitEthernet0/1" logging="False" state="present"

Context Example

{
    "CiscoIOS": {
        "IosNtp": {
            "changed": true,
            "commands": [
                "ntp source GigabitEthernet0/1"
            ],
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Commands

  • 0: ntp source GigabitEthernet0/1

ios-ping

Tests reachability using ping from Cisco IOS network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_ping_module.html

Base Command

ios-ping

Input

Context Output

ios-static-route

Manage static IP routes on Cisco IOS network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_static_route_module.html

Base Command

ios-static-route

Input

Context Output

Command Example

!ios-static-route host="123.123.123.123" prefix="192.168.2.0" mask="255.255.255.0" next_hop="10.0.0.1"

Context Example

{
    "CiscoIOS": {
        "IosStaticRoute": {
            "changed": false,
            "commands": [],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Commands

ios-system

Manage the system attributes on Cisco IOS devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_system_module.html

Base Command

ios-system

Input

Context Output

Command Example

!ios-system host="123.123.123.123" hostname="ios01" domain_name="test.example.com" domain_search="{{ ['ansible.com', 'redhat.com', 'cisco.com'] }}"

Context Example

{
    "CiscoIOS": {
        "IosSystem": {
            "changed": true,
            "commands": [
                "hostname ios01"
            ],
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Commands

  • 0: hostname ios01

ios-user

Manage the aggregate of local users on Cisco IOS device
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_user_module.html

Base Command

ios-user

Input

Context Output

Command Example

!ios-user host="123.123.123.123" name="ansible" nopassword="True" sshkey="ssh-rsa AAAA...u+DM=" state="present"

Context Example

{
    "CiscoIOS": {
        "IosUser": {
            "changed": true,
            "commands": [
                "ip ssh pubkey-chain",
                "username ansible",
                "key-hash ssh-rsa B1E29F17C950E2FEAB5BC3AC2A760208",
                "exit",
                "exit"
            ],
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Commands

  • 0: ip ssh pubkey-chain
  • 1: username ansible
  • 2: key-hash ssh-rsa B1E29F17C950E2FEAB5BC3AC2A760208
  • 3: exit
  • 3: exit

ios-vlans

Manage VLANs on Cisco IOS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_vlans_module.html

Base Command

ios-vlans

Input

Context Output

ios-vrf

Manage the collection of VRF definitions on Cisco IOS devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ios_vrf_module.html

Base Command

ios-vrf

Input

Context Output

Troubleshooting

The Ansible-Runner container is not suitable for running as a non-root user.
Therefore, the Ansible integrations will fail if you follow the instructions in Docker hardening guide (Cortex XSOAR 6.13) or Docker hardening guide (Cortex XSOAR 8 Cloud) or Docker hardening guide (Cortex XSOAR 8.7 On-prem).

The docker.run.internal.asuser server configuration causes the software that is run inside of the Docker containers utilized by Cortex XSOAR to run as a non-root user account inside the container.

The Ansible-Runner software is required to run as root as it applies its own isolation via bwrap to the Ansible execution environment.

This is a limitation of the Ansible-Runner software itself https://github.com/ansible/ansible-runner/issues/611.

A workaround is to use the docker.run.internal.asuser.ignore server setting and to configure Cortex XSOAR to ignore the Ansible container image by setting the value of demisto/ansible-runner and afterwards running /reset_containers to reload any containers that might be running to ensure they receive the configuration.

See step 2 of this Docker hardening guide (Cortex XSOAR 6.13). For Cortex XSOAR 8 Cloud see step 3 in Run Docker with non-root internal users of this Docker hardening guide (Cortex XSOAR 8 Cloud). For Cortex XSOAR 8.7 On-prem see step 3 in Run Docker with non-root internal users of this Docker hardening guide (Cortex XSOAR 8.7 On-prem) for complete instructions.