cisco.ios.ios_facts 模块 – 从远程设备收集事实的模块。
注意
此模块是 cisco.ios 集合 (版本 9.0.3) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.ios
。
要在剧本中使用它,请指定: cisco.ios.ios_facts
。
cisco.ios 1.0.0 中的新增功能
概要
从运行 IOS 的远程设备收集一组基本的设备事实。此模块将所有基本网络事实键名前缀加上
ansible_net_<fact>
。事实模块将始终从设备收集一组基本事实,并且可以启用或禁用其他事实的收集。
参数
参数 |
注释 |
---|---|
设置为“True”时,将提供可用于资源模块的网络资源列表。 选项
|
|
提供此参数时,它将收集的事实限制为给定的子集。此参数的可能值为 all 和诸如 interfaces、vlans 等资源。可以指定一个值列表以包含更大的子集。值也可以与初始 |
|
提供此参数时,它将收集的事实限制为给定的子集。 此参数的可能值为 指定一个值列表以包含更大的子集。 使用以初始 默认值: |
注释
注意
在 CML 上针对 Cisco IOS XE 版本 17.3 和针对 L2 特定资源的 IOS 15.6 进行了测试。
对于 L3 设备的事实收集,对于不支持的资源(如 vlan)应该会产生空白输出。
此模块与连接
network_cli
一起使用。请参阅 https://docs.ansible.org.cn/ansible/latest/network/user_guide/platform_ios.html有关使用 Ansible 管理网络设备的更多信息,请参阅:ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息,请参阅 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。
示例
- name: Gather all legacy facts
cisco.ios.ios_facts:
gather_subset: all
- name: Gather only the config and default facts
cisco.ios.ios_facts:
gather_subset:
- config
- name: Do not gather hardware facts
cisco.ios.ios_facts:
gather_subset:
- "!hardware"
- name: Gather legacy and resource facts
cisco.ios.ios_facts:
gather_subset: all
gather_network_resources: all
- name: Gather only the interfaces resource facts and no legacy facts
cisco.ios.ios_facts:
gather_subset:
- "!all"
- "!min"
gather_network_resources:
- interfaces
- name: Gather interfaces resource and minimal legacy facts
cisco.ios.ios_facts:
gather_subset: min
gather_network_resources: interfaces
- name: Gather L2 interfaces resource and minimal legacy facts
cisco.ios.ios_facts:
gather_subset: min
gather_network_resources: l2_interfaces
- name: Gather L3 interfaces resource and minimal legacy facts
cisco.ios.ios_facts:
gather_subset: min
gather_network_resources: l3_interfaces
返回值
常见返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
在设备上配置的所有 IPv4 地址 返回:配置 interfaces 时 |
|
在设备上配置的所有 IPv6 地址 返回:配置 interfaces 时 |
|
传输的名称 返回:始终返回 |
|
设备当前活动的配置 返回:配置 config 时 |
|
设备当前的 CPU 利用率 返回:配置 hardware 时 |
|
设备上可用的所有文件系统名称 返回:配置 hardware 时 |
|
包含有关每个文件系统信息(例如可用空间和总空间)的所有文件系统的哈希表 返回:配置 hardware 时 |
|
从设备收集的网络资源子集的事实列表 返回:配置资源时 |
|
从设备收集的事实子集列表 返回:始终返回 |
|
设备的已配置主机名 返回:始终返回 |
|
设备正在运行的镜像文件 返回:始终返回 |
|
系统上运行的所有接口的哈希表 返回:配置 interfaces 时 |
|
远程设备上运行的操作系统类型(IOS 或 IOS-XE) 返回:始终返回 |
|
远程设备上以 MiB 为单位的可用空闲内存 返回:配置 hardware 时 |
|
远程设备上以 MiB 为单位的总内存 返回:配置 hardware 时 |
|
设备返回的型号名称 返回:始终返回 |
|
来自远程设备的 CDP 和 LLDP 邻居列表。如果在一个端口上同时存在 CDP 和 LLDP 邻居数据,则优先使用 CDP。 返回:配置 interfaces 时 |
|
Ansible 控制器正在使用的 Python 版本 返回:始终返回 |
|
远程设备的序列号 返回:始终返回 |
|
堆叠中每个设备的型号名称 返回值:当多个设备配置在堆叠中时 |
|
堆叠中每个设备的序列号 返回值:当多个设备配置在堆叠中时 |
|
远程设备上运行的操作系统版本 返回:始终返回 |