mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
junos: Docs update
This commit is contained in:
parent
36ba105b91
commit
d4200b0389
5 changed files with 30 additions and 23 deletions
|
@ -26,7 +26,7 @@ description:
|
||||||
- Network devices running the Junos operating system provide a command
|
- Network devices running the Junos operating system provide a command
|
||||||
driven interface both over CLI and RPC. This module provides an
|
driven interface both over CLI and RPC. This module provides an
|
||||||
interface to execute commands using these functions and return the
|
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
|
module can specify a set of conditionals to be evaluated against the
|
||||||
returned output, only returning control to the playbook once the
|
returned output, only returning control to the playbook once the
|
||||||
entire set of conditionals has been met.
|
entire set of conditionals has been met.
|
||||||
|
@ -51,8 +51,9 @@ options:
|
||||||
- Specifies what to evaluate from the output of the command
|
- Specifies what to evaluate from the output of the command
|
||||||
and what conditionals to apply. This argument will cause
|
and what conditionals to apply. This argument will cause
|
||||||
the task to wait for a particular conditional or set of
|
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
|
conditional is not true by the configured retries, the
|
||||||
|
:1
|
||||||
task fails. See examples.
|
task fails. See examples.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
|
@ -60,8 +61,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies the number of retries a command should by tried
|
- Specifies the number of retries a command should by tried
|
||||||
before it is considered failed. The command is run on the
|
before it is considered failed. The command is run on the
|
||||||
target device every retry and evaluated against the waitfor
|
target device every retry and evaluated against the I(waitfor)
|
||||||
conditionals
|
conditionals.
|
||||||
required: false
|
required: false
|
||||||
default: 10
|
default: 10
|
||||||
interval:
|
interval:
|
||||||
|
|
|
@ -23,8 +23,8 @@ version_added: "2.1"
|
||||||
author: "Peter Sprygada (@privateip)"
|
author: "Peter Sprygada (@privateip)"
|
||||||
short_description: Manage configuration on remote devices running Junos
|
short_description: Manage configuration on remote devices running Junos
|
||||||
description:
|
description:
|
||||||
- The M(junos_config) module provides an abstraction for working
|
- Provides an abstraction for working
|
||||||
with the configuration running on remote devices. It can perform
|
with the configuration running on remote Junos devices. It can perform
|
||||||
operations that influence the configuration state.
|
operations that influence the configuration state.
|
||||||
- This module provides an implementation for configuring Juniper
|
- This module provides an implementation for configuring Juniper
|
||||||
JUNOS devices. The configuration statements must start with either
|
JUNOS devices. The configuration statements must start with either
|
||||||
|
@ -46,7 +46,7 @@ options:
|
||||||
current configuration to the identifier specified in the
|
current configuration to the identifier specified in the
|
||||||
argument. If the specified rollback identifier does not
|
argument. If the specified rollback identifier does not
|
||||||
exist on the remote device, the module will fail. To rollback
|
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
|
required: false
|
||||||
default: null
|
default: null
|
||||||
zeroize:
|
zeroize:
|
||||||
|
@ -54,8 +54,11 @@ options:
|
||||||
- The C(zeroize) argument is used to completely santaize the
|
- The C(zeroize) argument is used to completely santaize the
|
||||||
remote device configuration back to initial defaults. This
|
remote device configuration back to initial defaults. This
|
||||||
argument will effectively remove all current configuration
|
argument will effectively remove all current configuration
|
||||||
statements on the remote device
|
statements on the remote device.
|
||||||
required: false
|
required: false
|
||||||
|
choices:
|
||||||
|
- yes
|
||||||
|
- no
|
||||||
default: null
|
default: null
|
||||||
confirm:
|
confirm:
|
||||||
description:
|
description:
|
||||||
|
@ -77,9 +80,12 @@ options:
|
||||||
description:
|
description:
|
||||||
- The C(replace) argument will instruct the remote device to
|
- The C(replace) argument will instruct the remote device to
|
||||||
replace the current configuration hierarchy with the one specified
|
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.
|
from this module.
|
||||||
required: true
|
required: true
|
||||||
|
choices:
|
||||||
|
- yes
|
||||||
|
- no
|
||||||
default: false
|
default: false
|
||||||
requirements:
|
requirements:
|
||||||
- junos-eznc
|
- junos-eznc
|
||||||
|
|
|
@ -40,9 +40,9 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Specifies the state of the M(junos_netconf) resource on
|
- 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
|
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.
|
will be removed from the configuration.
|
||||||
required: true
|
required: true
|
||||||
default: present
|
default: present
|
||||||
|
|
|
@ -31,19 +31,19 @@ extends_documentation_fragment: junos
|
||||||
options:
|
options:
|
||||||
src:
|
src:
|
||||||
description:
|
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.
|
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
|
The I(src) argument can be either a localized path or a full
|
||||||
path to the package file to install
|
path to the package file to install.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: ['package']
|
aliases: ['package']
|
||||||
version:
|
version:
|
||||||
description:
|
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
|
version of the package that should be installed on the remote
|
||||||
device. If the O(version) argument is not specified, then
|
device. If the I(version) argument is not specified, then
|
||||||
the version is extracts from the O(src) filename
|
the version is extracts from the I(src) filename.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
reboot:
|
reboot:
|
||||||
|
@ -58,18 +58,18 @@ options:
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
no_copy:
|
no_copy:
|
||||||
description:
|
description:
|
||||||
- The O(no_copy) arugment is responsible for instructing the remote
|
- The I(no_copy) argument is responsible for instructing the remote
|
||||||
device on where to isntall the package from. When enabled, the
|
device on where to install the package from. When enabled, the
|
||||||
package is transferred to the remote device prior to installing.
|
package is transferred to the remote device prior to installing.
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- The O(force) argument instructs the module to bypass the package
|
- The I(force) argument instructs the module to bypass the package
|
||||||
version check and install the packaged identified in O(src) on
|
version check and install the packaged identified in I(src) on
|
||||||
the remote device.
|
the remote device.
|
||||||
require: true
|
required: true
|
||||||
default: false
|
default: false
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -23,7 +23,7 @@ version_added: "2.1"
|
||||||
author: "Peter Sprygada (@privateip)"
|
author: "Peter Sprygada (@privateip)"
|
||||||
short_description: Manage configuration on remote devices running Junos
|
short_description: Manage configuration on remote devices running Junos
|
||||||
description:
|
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
|
from a template file onto a remote device running Junos. The
|
||||||
module will return the differences in configuration if the diff
|
module will return the differences in configuration if the diff
|
||||||
option is specified on the Ansible command line
|
option is specified on the Ansible command line
|
||||||
|
|
Loading…
Reference in a new issue