ops_template - Push configuration to OpenSwitch

New in version 2.1.

Synopsis
Options
Examples
Return Values
This is a Core Module

Synopsis

The OpenSwitch platform provides a library for pushing JSON structured configuration files into the current running-config. This module will read the current configuration from OpenSwitch and compare it against a provided candidate configuration. If there are changes, the candidate configuration is merged with the current configuration and pushed into OpenSwitch

Options

parameter	required	default	choices	comments
backup	no		yes no	When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backups/ in the root of the playbook directory.
config	no			The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The config argument allows the implementer to pass in the configuruation to use as the base config for comparision.
force	no		yes no	The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of src into the device without first checking if already configured.
host	yes			Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. Note this argument does not affect the SSH argument.
password	no			Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or rest transports. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port	no	0 (use common port)		Specifies the port to use when buiding the connection to the remote device. This value applies to either cli or I(). The port value will default to the approriate transport common port if none is provided in the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport.
provider	no			Convience method that allows all openswitch arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
src	yes			The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.
ssh_keyfile	no			Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
transport	yes	ssh	ssh cli rest	Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over ssh, cli or REST.
use_ssl	no	True	yes no	Configures the transport to use SSL if set to true only when the transport argument is configured as rest. If the transport argument is not rest, this value is ignored
username	no			Configures the usename to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

- name: set hostname with file lookup
    ops_template:
    src: ./hostname.json
    backup: yes
    remote_user: admin
    become: yes

- name: set hostname with var
    ops_template:
    src: "{{ config }}"
    remote_user: admin
    become: yes

Return Values

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

name	description	returned	type	sample
updates	The list of configuration updates to be merged		dict	{'obj': None}
responses		when transport == cli	list	['...']

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.