cisco.iosxr.iosxr_system 模块 – 用于管理系统属性的模块。
注意
此模块是 cisco.iosxr 集合 (版本 10.2.2) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.iosxr
。您需要其他要求才能使用此模块,有关详细信息,请参阅 需求。
要在 playbook 中使用它,请指定: cisco.iosxr.iosxr_system
。
cisco.iosxr 1.0.0 中的新增功能
概要
此模块提供对 Cisco IOS XR 设备上的节点系统属性的声明式管理。它提供了一个选项来配置主机系统参数或从设备活动配置中删除这些参数。
需求
以下需求是在执行此模块的主机上所需的。
使用 netconf 时,ncclient >= 0.5.3
使用 netconf 时,lxml >= 4.1.1
参数
参数 |
注释 |
---|---|
将远程设备上的 IP 域名配置为提供的 value 值。value 值应采用点分十进制名称形式,并将附加到 |
|
提供要附加到主机名以进行名称解析的域名后缀列表。此参数接受名称列表,并将与正在运行节点上的当前活动配置协调。 |
|
配置设备主机名参数。此选项采用 ASCII 字符串值。 |
|
提供用于启用或禁用 DNS 查询的管理控制。当此参数设置为 True 时,将执行查询;当设置为 False 时,将不执行查询。 选项
|
|
|
|
|
|
设备当前活动配置中配置值的 state 状态。设置为 *present* 时,这些值应在设备活动配置中配置;设置为 *absent* 时,这些值不应在设备活动配置中。 选项
|
|
域名服务的 VRF 名称 默认值: |
备注
注意
此模块与连接
network_cli
和netconf
配合使用。请参见 IOS-XR 平台选项。使用
netconf
传输的 name-servers *state=absent* 操作成功,但出现 rpc 错误。这是由于 XR 平台问题导致的。建议将任务与 *ignore_errors* 选项一起使用作为解决方法。有关使用 Ansible 管理网络设备的更多信息,请参见:ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息,请参见 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。
示例
- name: configure hostname and domain-name (default vrf=default)
cisco.iosxr.iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
- name: remove configuration
cisco.iosxr.iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
state: absent
- name: configure hostname and domain-name with vrf
cisco.iosxr.iosxr_system:
hostname: iosxr01
vrf: nondefault
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
- name: configure DNS lookup sources
cisco.iosxr.iosxr_system:
lookup_source: MgmtEth0/0/CPU0/0
lookup_enabled: true
- name: configure name servers
cisco.iosxr.iosxr_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
要发送到设备的配置模式命令列表 返回: 始终 示例: |
|
使用传输 返回: 始终(没有要发送的 xml rpc 时为空列表) 示例: |