From d4200b03894f42128912198bc932e2d41cd99a2f Mon Sep 17 00:00:00 2001 From: John Barker Date: Thu, 4 Aug 2016 17:16:38 +0100 Subject: [PATCH] junos: Docs update --- .../modules/network/junos/junos_command.py | 9 ++++---- .../modules/network/junos/junos_config.py | 16 +++++++++----- .../modules/network/junos/junos_netconf.py | 4 ++-- .../modules/network/junos/junos_package.py | 22 +++++++++---------- .../modules/network/junos/junos_template.py | 2 +- 5 files changed, 30 insertions(+), 23 deletions(-) diff --git a/lib/ansible/modules/network/junos/junos_command.py b/lib/ansible/modules/network/junos/junos_command.py index 42056320bd5..ddfab906bb6 100644 --- a/lib/ansible/modules/network/junos/junos_command.py +++ b/lib/ansible/modules/network/junos/junos_command.py @@ -26,7 +26,7 @@ description: - Network devices running the Junos operating system provide a command driven interface both over CLI and RPC. This module provides an interface to execute commands using these functions and return the - results to the Ansible playbook. In addition, the M(junos_command) + results to the Ansible playbook. In addition, this module can specify a set of conditionals to be evaluated against the returned output, only returning control to the playbook once the entire set of conditionals has been met. @@ -51,8 +51,9 @@ options: - Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional or set of - considitonals to be true before moving forward. If the + conditionals to be true before moving forward. If the conditional is not true by the configured retries, the + :1 task fails. See examples. required: false default: null @@ -60,8 +61,8 @@ options: description: - Specifies the number of retries a command should by tried before it is considered failed. The command is run on the - target device every retry and evaluated against the waitfor - conditionals + target device every retry and evaluated against the I(waitfor) + conditionals. required: false default: 10 interval: diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 07b9fafb724..9a6e3092290 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -23,8 +23,8 @@ version_added: "2.1" author: "Peter Sprygada (@privateip)" short_description: Manage configuration on remote devices running Junos description: - - The M(junos_config) module provides an abstraction for working - with the configuration running on remote devices. It can perform + - Provides an abstraction for working + with the configuration running on remote Junos devices. It can perform operations that influence the configuration state. - This module provides an implementation for configuring Juniper JUNOS devices. The configuration statements must start with either @@ -46,7 +46,7 @@ options: current configuration to the identifier specified in the argument. If the specified rollback identifier does not exist on the remote device, the module will fail. To rollback - to the most recent commit, set the C(rollback) argument to 0 + to the most recent commit, set the C(rollback) argument to 0. required: false default: null zeroize: @@ -54,8 +54,11 @@ options: - The C(zeroize) argument is used to completely santaize the remote device configuration back to initial defaults. This argument will effectively remove all current configuration - statements on the remote device + statements on the remote device. required: false + choices: + - yes + - no default: null confirm: description: @@ -77,9 +80,12 @@ options: description: - The C(replace) argument will instruct the remote device to replace the current configuration hierarchy with the one specified - in the corresponding hierarchy of the source configuraiton loaded + in the corresponding hierarchy of the source configuration loaded from this module. required: true + choices: + - yes + - no default: false requirements: - junos-eznc diff --git a/lib/ansible/modules/network/junos/junos_netconf.py b/lib/ansible/modules/network/junos/junos_netconf.py index d8ce40103ef..3db3fa7347c 100644 --- a/lib/ansible/modules/network/junos/junos_netconf.py +++ b/lib/ansible/modules/network/junos/junos_netconf.py @@ -40,9 +40,9 @@ options: state: description: - Specifies the state of the M(junos_netconf) resource on - the remote device. If the O(state) argument is set to + the remote device. If the I(state) argument is set to I(present) the netconf service will be configured. If the - O(state) argument is set to I(absent) the netconf service + I(state) argument is set to I(absent) the netconf service will be removed from the configuration. required: true default: present diff --git a/lib/ansible/modules/network/junos/junos_package.py b/lib/ansible/modules/network/junos/junos_package.py index 897fef41b1a..f11e121b241 100644 --- a/lib/ansible/modules/network/junos/junos_package.py +++ b/lib/ansible/modules/network/junos/junos_package.py @@ -31,19 +31,19 @@ extends_documentation_fragment: junos options: src: description: - - The O(src) argument specifies the path to the source package to be + - The I(src) argument specifies the path to the source package to be installed on the remote device in the advent of a version mismatch. - The O(src) argument can be either a localized path or a full - path to the package file to install + The I(src) argument can be either a localized path or a full + path to the package file to install. required: true default: null aliases: ['package'] version: description: - - The O(version) argument can be used to explicitly specify the + - The I(version) argument can be used to explicitly specify the version of the package that should be installed on the remote - device. If the O(version) argument is not specified, then - the version is extracts from the O(src) filename + device. If the I(version) argument is not specified, then + the version is extracts from the I(src) filename. required: false default: null reboot: @@ -58,18 +58,18 @@ options: choices: ['true', 'false'] no_copy: description: - - The O(no_copy) arugment is responsible for instructing the remote - device on where to isntall the package from. When enabled, the + - The I(no_copy) argument is responsible for instructing the remote + device on where to install the package from. When enabled, the package is transferred to the remote device prior to installing. required: false default: false choices: ['true', 'false'] force: description: - - The O(force) argument instructs the module to bypass the package - version check and install the packaged identified in O(src) on + - The I(force) argument instructs the module to bypass the package + version check and install the packaged identified in I(src) on the remote device. - require: true + required: true default: false choices: ['true', 'false'] requirements: diff --git a/lib/ansible/modules/network/junos/junos_template.py b/lib/ansible/modules/network/junos/junos_template.py index 81d8dacde43..8bbdbc19f81 100644 --- a/lib/ansible/modules/network/junos/junos_template.py +++ b/lib/ansible/modules/network/junos/junos_template.py @@ -23,7 +23,7 @@ version_added: "2.1" author: "Peter Sprygada (@privateip)" short_description: Manage configuration on remote devices running Junos description: - - The M(junos_template) module will load a candidate configuration + - This module will load a candidate configuration from a template file onto a remote device running Junos. The module will return the differences in configuration if the diff option is specified on the Ansible command line