ansible.netcommon.grpc_config_module.rst

ansible.netcommon.grpc_config

Fetch configuration/state data from gRPC enabled target hosts.

Version added: 3.1.0

Synopsis

• gRPC is a high performance, open-source universal RPC framework.
• This module allows the user to append configs to an existing configuration in a gRPC enabled devices.

Requirements

The below requirements are needed on the host that executes this module.

• grpcio
• protobuf

Parameters

Parameter		Choices/Defaults	Comments
backup boolean		Choices: no ← yes	This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
backup_options dictionary			This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored.
	dir_path path		This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
	filename string		The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
config string			This option specifies the string which acts as a filter to restrict the portions of the data to be retrieved from the target host device. If this option is not specified the entire configuration or state data is returned in response provided it is supported by target host.
state string			action to be performed

Notes

Note

- This module requires the gRPC system service be enabled on the target host being managed. - This module supports the use of connection=connection=ansible.netcommon.grpc - This module requires the value of 'ansible_network_os' or 'grpc_type' configuration option (refer ansible.netcommon.grpc connection plugin documentation) be defined as an inventory variable. - Tested against iosxrv 9k version 6.1.2.

Examples

- name: Merge static route config
  ansible.netcommon.grpc_config:
    config:
      Cisco-IOS-XR-ip-static-cfg:router-static:
        default-vrf:
          address-family:
            vrfipv4:
              vrf-unicast:
                vrf-prefixes:
                  vrf-prefix:
                    - prefix: "1.2.3.6"
                      prefix-length: 32
                      vrf-route:
                        vrf-next-hop-table:
                          vrf-next-hop-next-hop-address:
                            - next-hop-address: "10.0.2.2"
    state: merged

- name: Merge bgp config
  ansible.netcommon.grpc_config:
    config: "{{ lookup('file', 'bgp.json')  }}"
    state: merged

- name: Find diff
  diff: true
  ansible.netcommon.grpc_config:
    config: "{{ lookup('file', 'bgp_start.yml')  }}"
    state: merged

- name: Backup running config
  ansible.netcommon.grpc_config:
    backup: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
backup_path string	when backup is yes	The full path to the backup file Sample: /playbooks/ansible/backup/config.2022-07-16@22:28:34
diff dictionary	when diff is enabled	If --diff option in enabled while running, the before and after configuration change are returned as part of before and after key.
stdout string	error mesage, when failure happens. empty , when the operation is successful	The raw string containing response object received from the gRPC server. Sample: ...
stdout_lines list	always apart from low-level errors (such as action plugin)	The value of stdout split into a list Sample: ['...', '...']

Status

Authors

• Gomathi Selvi S (@GomathiselviS)