Update Interface Configuration

This task allows the user to configure the properties of one or more Cisco switch interfaces.

It requires details to access a Cisco switch via SSH.

Playbook Files

# This task has been designed using a Catalyst Cisco Managed Switch WS-C3560G-24PS-S
plugins:
  cisco_ios_switch: ~1
  hashicorp_vault: ~4.1
  ppa: ~3
  ppa_tools: ~3

set:
  config_changed: false

steps:
  - name: Description
    actions:
      - ppa.ui.output_markdown:
          doc: |
            {{ globals.icons.cisco.full }}
            ### Switch Interface Configuration
            Use this task to configure the properties of one or more switch interfaces.

            You will need to:

            - Select one or more interfaces to configure
            - Choose the properties you wish to change
            - Supply new values for each property


            An updated interfaces table will be displayed at the end of the task.
      - ppa.ui.input_accept:
          text: Start

  - name: Get Credentials
    actions:
      - hashicorp_vault.key_value.read_secret_keys:
          secret: cisco
          keys:
            - address
            - port
            - username
            - base_prompt
          sensitive_keys:
            - enable_password
            - password
          create_missing: true
        save: cisco_info

  - name: Select a port
    actions:
      - cisco_ios_switch.interfaces.get_all:
          progress_bar: true
        load:
          cisco_switch: cisco_info
        save: all_interfaces

      - cisco_ios_switch.interfaces.input_table:
          text: Select the interfaces you wish to configure
          minimum: 1
        load:
          interface_list: all_interfaces
        save: selected_interfaces

      - count:
        load:
          item: selected_interfaces
        save: interface_count

  - name: Select Settings
    until: not start_next_interface # This breaks the loop if the user clicks "Skip Remaining"
    sequence: selected_interfaces
    actions:
      - set:
          name: state
          value: ""

      # This needs a default value in case the confirm button that sets
      # it further down isn't triggered. The default value is safe.
      - set:
          name: start_next_interface
          value: True

      - cisco_ios_switch.interfaces.ethernet_summary:
        load:
          interface: loop.step.item.value
        save: interface_summary

      - ppa.ui.output_markdown:
          doc: >
            ### Interface {{ loop.step.item.value.port }} ({{ loop.step.item.index + 1 }} of {{ interface_count }} selected)
            {{ interface_summary }}

      - set:
          name: settings_rows
          value:
            - - Status
              - "{{ 'disabled' if loop.step.item.value.status == 'disabled' else 'enabled'}}"
            - - Speed
              - "{{loop.step.item.value.speed}}"
            - - Duplex
              - "{{loop.step.item.value.duplex}}"
            - - Name
              - "{{loop.step.item.value.name}}"

      - ppa.ui.input_table:
          text: "Select the properties to change on port {{loop.step.item.value.port}}"
          header:
            - Property
            - Current Setting
        load:
          rows: settings_rows
        save: selected_settings_rows

      - eval:
          expression: >
            [settings_rows[selection][0] for selection in selected_settings_rows]
        save: selected_properties

      - set:
          name: config_changed
          value: True
        when: selected_properties

      # Only show the skipped message if there is another interface to show, because
      # the generic 'nothing was applied' message at the end will be displayed anyway.
      - ppa.ui.output_info:
          text: No properties were selected, interface {{ loop.step.item.value.port }} will be skipped.
        when: not selected_properties

      - ppa.ui.input_choice:
          text: "Select a status (current value: {{ 'disabled' if loop.step.item.value.status == 'disabled' else 'enabled'}})"
          options:
            enabled: enable
            disabled: disable
        save: state
        when: >
          "Status" in selected_properties

      # Enable
      - cisco_ios_switch.interfaces.enable:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          cisco_switch: cisco_info
          enable_password: cisco_info.enable_password
        when: >
          state == "enable" and "Status" in selected_properties

      # Disable
      - cisco_ios_switch.interfaces.disable:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          cisco_switch: cisco_info
          enable_password: cisco_info.enable_password
        when: >
          state == "disable" and "Status" in selected_properties

      # Change speed
      - cisco_ios_switch.interfaces.capable_speeds:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          cisco_switch: cisco_info
        save: valid_speeds
        when: >
          "Speed" in selected_properties
      - ppa.ui.input_choice:
          text: "Select a speed (current value: {{ loop.step.item.value.speed }})"
        load:
          options: valid_speeds
        save: speed
        when: >
          "Speed" in selected_properties

      - cisco_ios_switch.interfaces.set_speed:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          speed: speed
          cisco_switch: cisco_info
          enable_password: cisco_info.enable_password
        when: >
          "Speed" in selected_properties

      # Change duplex
      - cisco_ios_switch.interfaces.capable_duplexes:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          cisco_switch: cisco_info
        save: valid_duplexes
        when: >
          "Duplex" in selected_properties
      - ppa.ui.input_choice:
          text: "Select a duplex (current value: {{ loop.step.item.value.duplex }})"
        load:
          options: valid_duplexes
        save: duplex
        when: >
          "Duplex" in selected_properties

      - cisco_ios_switch.interfaces.set_duplex:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          duplex: duplex
          cisco_switch: cisco_info
          enable_password: cisco_info.enable_password
        when: >
          "Duplex" in selected_properties

      # Change name
      - ppa.ui.input_text:
          text: "Supply a name (current value: {{ loop.step.item.value.name or 'empty' }})"
        save: name
        when: >
          "Name" in selected_properties

      - cisco_ios_switch.interfaces.set_name:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          name: name
          cisco_switch: cisco_info
          enable_password: cisco_info.enable_password
        when: >
          "Name" in selected_properties

      # Display Changes
      - cisco_ios_switch.interfaces.get_by_port:
          progress_bar: true
        load:
          port: loop.step.item.value.port
          cisco_switch: cisco_info
        save: updated_interface
        when: selected_properties

      - ppa_tools.lists.append:
          items: []
        load:
          value: updated_interface
        save: updated_interface_list
        when: selected_properties

      - cisco_ios_switch.interfaces.output_table:
          text: "Updated configuration for interface {{ loop.step.item.value.port }}"
        load:
          interface_list: updated_interface_list
        when: selected_properties

      - ppa.ui.input_confirm:
          text: Please Choose an Option
          confirm: Next Interface
          cancel: Skip Remaining Interfaces
        save: start_next_interface
        when: >
          (loop["step"]["item"]["index"] + 1) < int(interface_count)

  - name: Skip Summary if no changes
    when: not config_changed
    actions:
      - ppa.ui.output_info:
          text: No property changes were chosen for any selected interfaces.

  - name: Save Running Configuration
    when: config_changed
    actions:
      - ppa.ui.output_info:
          text: Configuration changes have been applied to all selected interfaces.

      - ppa.ui.input_confirm:
          text: Would you like to copy running configuration to startup configuration?
          confirm: Yes
          cancel: No
        save: copy_config

      - cisco_ios_switch.config.write_memory:
          progress_bar: true
        load:
          enable_password: cisco_info.enable_password
          cisco_switch: cisco_info
        when: copy_config

  - name: Show Summary
    when: config_changed
    actions:
      - cisco_ios_switch.interfaces.get_all:
          progress_bar: true
        load:
          cisco_switch: cisco_info
        save: all_interfaces_update

      - cisco_ios_switch.interfaces.output_table:
          text: All interfaces after configuration changes
        load:
          interface_list: all_interfaces_update

Running this Playbook

Click download playbook
Import the downloaded file via the Playbooks page on PPA
Build the playbook from the Edit & Build tab
Run the playbook from the Preview & Deploy tab

* Requires PPA v2.9.x or newer

Integrations

PPA User Interface
Hashicorp Vault Key-Value engine
SSH Running Commands
Cisco IOS Switch Interfaces

Required Vault Details

Cisco Switch

Address
Port
Username
Password
Enable Password
Base Prompt

Vault Configuration Wizard

The first time you run a task built from this playbook, PPA will check the required Vault details exist.

If they don't exist, PPA will ask you to supply the details at the start of the task.

Below you can see a user providing details the first time they run an Active Directory task.

vault-config-wizard

Once the details are added to Vault, the task won't ask for them again.

If you don't know the required details, ask an administrator to run the task or configure Vault manually.

What the Task Does

When run this task will:

Ask the user to provide access details for the switch
Ask user to select one or more interfaces to configure
Ask user to choose the properties to change
Ask user to supply new values for each property
An updated interfaces table will be displayed at the end of the task.

See our other playbooks

Get PPA for free!

Start automating your estate with a free 30 day trial today. No signup required!

Get PPA Express

Documentation

Installation Guide
See how easy it is to get started with our installation guide
Playbooks
View our task writing reference guide
Plugins
See how to integrate with different systems using our plugins reference guide.