Ansible で Cisco Nexus スイッチのコマンドログを取得するための Playbook 作成ガイド

(venv) [root@CentOSST9 ~]# ansible-galaxy collection list

# /root/venv/lib/python3.12/site-packages/ansible_collections
Collection                               Version
---------------------------------------- -------
amazon.aws                               8.2.1
ansible.netcommon                        6.1.3
ansible.posix                            1.5.4
ansible.utils                            4.1.0
ansible.windows                          2.5.0
(中略)
cisco.ios                                8.0.0
cisco.iosxr                              9.0.0
cisco.ise                                2.9.3
cisco.meraki                             2.18.1
cisco.mso                                2.9.0
cisco.nxos                               8.1.0
cisco.ucs                                1.11.0
cloud.common                             3.0.0
cloudscale_ch.cloud                      2.4.0
(以下略)

The hostname is Nexus01.

# =========================== Start: show clock ===========================
"Warning: No NTP peer/server configured. Time may be out of sync.
06:40:24.876 UTC Sun Sep 29 2024
Time source is NTP"
# =========================== End  : show clock ===========================

# =========================== Start: show version ===========================
"Cisco Nexus Operating System (NX-OS) Software
TAC support: http://www.cisco.com/tac

(中略)

Active Package(s):"
# =========================== End  : show version ===========================

# =========================== Start: show running-config ===========================
"!Command: show running-config
!Running configuration last done at: Sun Sep 29 05:38:13 2024
!Time: Sun Sep 29 06:40:33 2024

version 9.3(10) Bios:version
(以下略)

log
    20240929-151919
        1-1_Nexus01_20240929.txt
    20240929-152018
        1-1_Nexus01_20240929.txt
    20240929-152207
        1-1_Nexus01_20240929.txt
    20240929-154309
        1-1_Nexus01_20240929.txt

all:
  hosts: #←いずれのホストグループにも属さないホストはこの配下に記載。本例ではこのようなホストとは無し
  vars: #←全ホスト共通の変数はこの配下に記載
    ansible_connection: ansible.netcommon.network_cli
    ansible_network_os: cisco.nxos.nxos
    ansible_become: yes
    ansible_become_method: enable
    fname_prefix: "1-1_" #←保存するログファイル名の頭に付与する文字列を定義
  children: #←ホストグループはchildren配下に記載
    nxos: #←本例ではnxosという名前のグループを定義
      hosts: #←このホストグループに所属するホストはhosts配下に記載
        Nexus01: #←個別ホストの定義と、ホスト固有変数の定義
          ansible_host: 192.168.75.253
          ansible_user: admin
          ansible_password: admin
          ansible_become_password: "" #←enableパスワードは必要な場合のみ記載
      vars: #←ホストグループ変数
        cmd_list: #←このホストグループで使用するコマンドリストをリスト型変数で定義
          - show clock
          - show version
          - show running-config
          - show inventory
          - show environment
          - show ip route

- name: Get Command Log
  hosts: all
  gather_facts: no

  tasks:
    - name: STEP1_Set Date Time
      set_fact:
        date: "{{ now(False, '%Y%m%d') }}"
        datetime: "{{ now(False, '%Y%m%d-%H%M%S') }}"
      run_once: true
    - name: STEP2_Gather Facts
      cisco.nxos.nxos_facts:
        gather_subset: min
    - name: STEP3_Set File Path
      set_fact:
        filepath: "./log/{{ datetime }}/{{ fname_prefix }}{{ ansible_net_hostname }}_{{ date }}.txt"
    - name: STEP4_Execute Commands
      cisco.nxos.nxos_command:
        commands: "{{ item }}"
      register: command_log
      with_items: "{{ cmd_list }}"
      ignore_errors: true
    - name: STEP5_Create File and Add Hostname
      lineinfile:
        path: "{{ filepath }}"
        line: "The hostname is {{ ansible_net_hostname }}."
        create: yes
    - name: STEP6_Add Command Log
      blockinfile:
        path: "{{ filepath }}"
        marker: "# {mark}"
        marker_begin: "=========================== Start: {{ item.item }} ==========================="
        marker_end: "=========================== End  : {{ item.item }} ==========================="
        prepend_newline: true
        block: |
          "{{ item.stdout | join('\n') }}"
        create: yes
      with_items:
        - "{{ command_log.results }}"
      loop_control:
        label: "{{ item.item }}"
      when: item.stdout is defined

(venv) [root@CentOSST9 ansible]# ansible-playbook -i hosts_nxos_getlog nxos_getcmdlog.yml

PLAY [Get Command Log] **********************************************************************************************

TASK [STEP1_Set Date Time] ******************************************************************************************
ok: [Nexus01]

TASK [STEP2_Gather Facts] *******************************************************************************************
ok: [Nexus01]

TASK [STEP3_Set File Path] ******************************************************************************************
ok: [Nexus01]

TASK [STEP4_Execute Commands] ***************************************************************************************
ok: [Nexus01] => (item=show clock)
ok: [Nexus01] => (item=show version)
ok: [Nexus01] => (item=show running-config)
ok: [Nexus01] => (item=show inventory)
ok: [Nexus01] => (item=show environment)
ok: [Nexus01] => (item=show ip route)

TASK [STEP5_Create File and Add Hostname] ***************************************************************************
changed: [Nexus01]

TASK [STEP6_Add Command Log] ****************************************************************************************
changed: [Nexus01] => (item=show clock)
changed: [Nexus01] => (item=show version)
changed: [Nexus01] => (item=show running-config)
changed: [Nexus01] => (item=show inventory)
changed: [Nexus01] => (item=show environment)
changed: [Nexus01] => (item=show ip route)

PLAY RECAP **********************************************************************************************************
Nexus01                    : ok=6    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

(venv) [root@CentOSST9 ansible]# ansible-playbook -i hosts_nxos_getlog nxos_getcmdlog.yml

PLAY [Get Command Log] **********************************************************************************************

TASK [STEP1_Set Date Time] ******************************************************************************************
ok: [Nexus01]

TASK [STEP2_Gather Facts] *******************************************************************************************
ok: [Nexus01]

TASK [STEP3_Set File Path] ******************************************************************************************
ok: [Nexus01]

TASK [STEP4_Execute Commands] ***************************************************************************************
ok: [Nexus01] => (item=show clock)
ok: [Nexus01] => (item=show version)
ok: [Nexus01] => (item=show running-config)
failed: [Nexus01] (item=show hogepiyo) => {"ansible_loop_var": "item", "changed": false, "item": "show hogepiyo", "msg": "show hogepiyo\r\r\n                ^\r\n% Invalid command at '^' marker.\r\n\rNexus01# "}
ok: [Nexus01] => (item=show inventory)
ok: [Nexus01] => (item=show environment)
ok: [Nexus01] => (item=show ip route)
...ignoring

TASK [STEP5_Create File and Add Hostname] ***************************************************************************
changed: [Nexus01]

TASK [STEP6_Add Command Log] ****************************************************************************************
changed: [Nexus01] => (item=show clock)
changed: [Nexus01] => (item=show version)
changed: [Nexus01] => (item=show running-config)
skipping: [Nexus01] => (item=show hogepiyo)
changed: [Nexus01] => (item=show inventory)
changed: [Nexus01] => (item=show environment)
changed: [Nexus01] => (item=show ip route)

PLAY RECAP **********************************************************************************************************
Nexus01                    : ok=6    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=1

log
    20240929-151919
        1-1_Nexus01_20240929.txt
    20240929-152018
        1-1_Nexus01_20240929.txt
    20240929-152207
        1-1_Nexus01_20240929.txt
    20240929-154309
        1-1_Nexus01_20240929.txt