grpc¶

Collection Note

This module is part of the ansible.netcommon collection. To install the collection, use:

ansible-galaxy collection install ansible.netcommon

Added in version 3.1.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

This connection plugin provides a connection to remote devices over gRPC and is typically used with devices for sending and receiving RPC calls over gRPC framework.
Note this connection plugin requires the grpcio python library to be installed on the local Ansible controller.

Requirements¶

The following Python packages are needed on the host that executes this module:

Parameters¶

Parameter	Defaults / Choices	Comments
certificate_chain_file string		The PEM encoded certificate chain file used to create a SSL-enabled channel. If the value is None, no certificate chain is used. Env: ANSIBLE_CERTIFICATE_CHAIN_FILE
grpc_type		This option indicates the grpc type and it can be used in place of network_os. (example cisco.iosxr.iosxr) Env: ANSIBLE_GRPC_CONNECTION_TYPE
host string	Default: inventory_hostname	Specifies the remote device FQDN or IP address to establish the gRPC connection to.
import_modules boolean	Default: True	Reduce CPU usage and network module execution time by enabling direct execution. Instead of the module being packaged and executed by the shell, it will be directly executed by the Ansible control node using the same python interpreter as the Ansible process. Note- Incompatible with C(asynchronous mode). Note- Python 3 and Ansible 2.9.16 or greater required. Note- With Ansible 2.9.x fully qualified modules names are required in tasks. Env: ANSIBLE_NETWORK_IMPORT_MODULES
network_os string		Configures the device platform network operating system. This value is used to load a device specific grpc plugin to communicate with the remote device.
password string		Configures the user password used to authenticate to the remote device when first establishing the gRPC connection.
persistent_command_timeout int	Default: 30	Configures, in seconds, the amount of time to wait for a command to return from the remote device. If this timer is exceeded before the command returns, the connection plugin will raise an exception and close. Env: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
persistent_connect_timeout int	Default: 30	Configures, in seconds, the amount of time to wait when trying to initially establish a persistent connection. If this value expires before the connection to the remote device is completed, the connection will fail. Env: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
persistent_log_messages boolean		This flag will enable logging the command executed and response received from target device in the ansible log file. For this option to work 'log_path' ansible configuration option is required to be set to a file path with write access. Be sure to fully understand the security implications of enabling this option as it could create a security vulnerability by logging sensitive information in log file. Env: ANSIBLE_PERSISTENT_LOG_MESSAGES
port int		Specifies the port on the remote device that listens for connections when establishing the gRPC connection. If None only the C(host) part will be used. Env: ANSIBLE_REMOTE_PORT
private_key_file string		The PEM encoded private key file used to authenticate to the remote device when first establishing the grpc connection. Env: ANSIBLE_PRIVATE_KEY_FILE
remote_user string		The username used to authenticate to the remote device when the gRPC connection is first established. If the remote_user is not specified, the connection will use the username of the logged in user. Can be configured from the CLI via the C(--user) or C(-u) options. Env: ANSIBLE_REMOTE_USER
root_certificates_file string		The PEM encoded root certificate file used to create a SSL-enabled channel, if the value is None it reads the root certificates from a default location chosen by gRPC at runtime. Env: ANSIBLE_ROOT_CERTIFICATES_FILE
ssl_target_name_override string		The option overrides SSL target name used for SSL host name checking. The name used for SSL host name checking will be the target parameter (assuming that the secure channel is an SSL channel). If this parameter is specified and the underlying is not an SSL channel, it will just be ignored. Env: ANSIBLE_GPRC_SSL_TARGET_NAME_OVERRIDE

Authors¶

Ansible Networking Team (@ansible-Network)