ansible.netcommon.grpc connection – Provides a persistent connection using the gRPC protocol
Note
This connection plugin is part of the ansible.netcommon collection (version 4.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.netcommon.
You need further requirements to be able to use this connection plugin,
see Requirements for details.
To use it in a playbook, specify: ansible.netcommon.grpc.
New in ansible.netcommon 3.1.0
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 below requirements are needed on the local controller node that executes this connection.
grpcio
protobuf
Parameters
Parameter |
Comments |
|---|---|
The PEM encoded certificate chain file used to create a SSL-enabled channel. If the value is None, no certificate chain is used. Configuration:
|
|
This option indicates the grpc type and it can be used in place of network_os. (example cisco.iosxr.iosxr) Default: Configuration:
|
|
Specifies the remote device FQDN or IP address to establish the gRPC connection to. Default: Configuration:
|
|
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 Choices:
Configuration:
|
|
Configures the device platform network operating system. This value is used to load a device specific grpc plugin to communicate with the remote device. Configuration:
|
|
Configures the user password used to authenticate to the remote device when first establishing the gRPC connection. Configuration:
|
|
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. Default: Configuration:
|
|
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. Default: Configuration:
|
|
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. Choices:
Configuration:
|
|
Specifies the port on the remote device that listens for connections when establishing the gRPC connection. If None only the Configuration:
|
|
The PEM encoded private key file used to authenticate to the remote device when first establishing the grpc connection. Configuration:
|
|
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 Configuration:
|
|
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. Configuration:
|
|
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. Configuration:
|