From 3ddd61f468c3b56aeeedf1ab43d5b446f3e2d251 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 4 Sep 2024 12:34:17 +0000 Subject: [PATCH] chore: auto fixes from pre-commit.com hooks --- ...unipernetworks.junos.junos_acls_module.rst | 1277 -- ....junos.junos_bgp_address_family_module.rst | 7712 ----------- ...networks.junos.junos_bgp_global_module.rst | 11520 ---------------- ...nipernetworks.junos.junos_facts_module.rst | 162 - ...networks.junos.junos_interfaces_module.rst | 1175 -- ...works.junos.junos_l2_interfaces_module.rst | 1213 -- ...rks.junos.junos_lacp_interfaces_module.rst | 1100 -- ...orks.junos.junos_lag_interfaces_module.rst | 987 -- ...etworks.junos.junos_lldp_global_module.rst | 444 - ...orks.junos.junos_logging_global_module.rst | 5615 -------- ...networks.junos.junos_ntp_global_module.rst | 1551 --- ...ipernetworks.junos.junos_ospfv2_module.rst | 1995 --- ...pernetworks.junos.junos_package_module.rst | 424 - ...unipernetworks.junos.junos_ping_module.rst | 366 - ...junipernetworks.junos.junos_rpc_module.rst | 219 - ...junipernetworks.junos.junos_scp_module.rst | 376 - ...etworks.junos.junos_snmp_server_module.rst | 6131 -------- ...works.junos.junos_static_routes_module.rst | 714 - ...unipernetworks.junos.junos_user_module.rst | 447 - 19 files changed, 43428 deletions(-) delete mode 100644 docs/junipernetworks.junos.junos_acls_module.rst delete mode 100644 docs/junipernetworks.junos.junos_bgp_address_family_module.rst delete mode 100644 docs/junipernetworks.junos.junos_bgp_global_module.rst delete mode 100644 docs/junipernetworks.junos.junos_facts_module.rst delete mode 100644 docs/junipernetworks.junos.junos_interfaces_module.rst delete mode 100644 docs/junipernetworks.junos.junos_l2_interfaces_module.rst delete mode 100644 docs/junipernetworks.junos.junos_lacp_interfaces_module.rst delete mode 100644 docs/junipernetworks.junos.junos_lag_interfaces_module.rst delete mode 100644 docs/junipernetworks.junos.junos_lldp_global_module.rst delete mode 100644 docs/junipernetworks.junos.junos_logging_global_module.rst delete mode 100644 docs/junipernetworks.junos.junos_ntp_global_module.rst delete mode 100644 docs/junipernetworks.junos.junos_ospfv2_module.rst delete mode 100644 docs/junipernetworks.junos.junos_package_module.rst delete mode 100644 docs/junipernetworks.junos.junos_ping_module.rst delete mode 100644 docs/junipernetworks.junos.junos_rpc_module.rst delete mode 100644 docs/junipernetworks.junos.junos_scp_module.rst delete mode 100644 docs/junipernetworks.junos.junos_snmp_server_module.rst delete mode 100644 docs/junipernetworks.junos.junos_static_routes_module.rst delete mode 100644 docs/junipernetworks.junos.junos_user_module.rst diff --git a/docs/junipernetworks.junos.junos_acls_module.rst b/docs/junipernetworks.junos.junos_acls_module.rst deleted file mode 100644 index ea8584d2..00000000 --- a/docs/junipernetworks.junos.junos_acls_module.rst +++ /dev/null @@ -1,1277 +0,0 @@ -.. _junipernetworks.junos.junos_acls_module: - - -******************************** -junipernetworks.junos.junos_acls -******************************** - -**ACLs resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of acls/filters on Juniper JUNOS devices - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of acls options
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
List of Access Control Lists (ACLs).
-
-
- aces - -
- list - / elements=dictionary -
- 		- -
List of Access Control Entries (ACEs) for this Access Control List (ACL).
-
-
- destination - -
- dictionary -
- 		- -
Specifies the destination for the filter
-
-
- address - -
- raw -
- 		- -
Match IP destination address
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol.
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers
-
-
- end - -
- integer -
- 		- -
Specify the end of the port range
-
-
- start - -
- integer -
- 		- -
Specify the start of the port range
-
-
- prefix_list - -
- list - / elements=dictionary -
- 		- -
Match IP destination prefixes in named list
-
-
- name - -
- string -
- 		- -
Name of the list
-
-
- grant - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Action to take after matching condition (allow, discard/reject)
-
-
- name - -
- string - / required -
- 		- -
Filter term name
-
-
- protocol - -
- string -
- 		- -
Specify the protocol to match.
-
Refer to vendor documentation for valid values.
-
-
- protocol_options - -
- dictionary -
- 		- -
All possible suboptions for the protocol chosen.
-
-
- icmp - -
- dictionary -
- 		- -
ICMP protocol options.
-
-
- dod_host_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host prohibited
-
-
- dod_net_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net prohibited
-
-
- echo - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo (ping)
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply
-
-
- host_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect
-
-
- host_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect for TOS
-
-
- host_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for TOS
-
-
- host_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unknown
-
-
- host_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable
-
-
- net_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network redirect
-
-
- net_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net redirect for TOS
-
-
- network_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unknown
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable
-
-
- protocol_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Protocol unreachable
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout
-
-
- redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All redirects
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery advertisements
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery solicitations
-
-
- source_route_failed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source route failed
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- ttl_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
TTL exceeded
-
-
- source - -
- dictionary -
- 		- -
Specifies the source for the filter
-
-
- address - -
- raw -
- 		- -
IP source address to use for the filter
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the source port or protocol.
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers
-
-
- end - -
- integer -
- 		- -
Specify the end of the port range
-
-
- start - -
- integer -
- 		- -
Specify the start of the port range
-
-
- prefix_list - -
- list - / elements=dictionary -
- 		- -
IP source prefix list to use for the filter
-
-
- name - -
- string -
- 		- -
Name of the list
-
-
- name - -
- string - / required -
- 		- -
Name to use for the acl filter
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Protocol family to use by the acl filter
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show firewall.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed - - This module works with connection ``netconf`` - - See `the Junos OS Platform Options `_ - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # admin# show firewall - - - name: Merge JUNOS acl - junipernetworks.junos.junos_acls: - config: - - afi: ipv4 - acls: - - name: allow_ssh_acl - aces: - - name: ssh_rule - source: - port_protocol: - eq: ssh - protocol: tcp - state: merged - - # After state: - # ------------- - # admin# show firewall - # family inet { - # filter allow_ssh_acl { - # term ssh_rule { - # from { - # protocol tcp; - # source-port ssh; - # } - # } - # } - # } - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['command 1', 'command 2', 'command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniel Mellado (@dmellado) diff --git a/docs/junipernetworks.junos.junos_bgp_address_family_module.rst b/docs/junipernetworks.junos.junos_bgp_address_family_module.rst deleted file mode 100644 index d0915c0d..00000000 --- a/docs/junipernetworks.junos.junos_bgp_address_family_module.rst +++ /dev/null @@ -1,7712 +0,0 @@ -.. _junipernetworks.junos.junos_bgp_address_family_module: - - -********************************************** -junipernetworks.junos.junos_bgp_address_family -********************************************** - -**Manage BGP Address Family attributes of interfaces on Junos devices.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage BGP Address Family attributes of interfaces on Junos network devices. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
The provided link BGP address family dictionary.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Enable address family and enter its config mode.
-
-
- af_type - -
- list - / elements=dictionary -
- 		- -
Address family type for ipv4.
-
-
- accepted_prefix_limit - -
- dictionary -
- 		- -
Specify limit for maximum number of prefixes accepted from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Specify teardown percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes accepted from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- add_path - -
- dictionary -
- 		- -
Advertise multiple paths to peer.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Receive multiple paths from peer.
-
-
- send - -
- dictionary -
- 		- -
Send multiple paths to peer.
-
-
- include_backup_path - -
- integer -
- 		- -
Specify number of backup paths to advertise.
-
-
- multipath - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include only multipath contributor routes.
-
-
- path_count - -
- integer - / required -
- 		- -
Include only multipath contributor routes.
-
-
- path_selection_mode - -
- dictionary -
- 		- -
Configure how to select add-path routes.
-
-
- all_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise all paths allowed by path count.
-
-
- equal_cost_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise equal cost paths.
-
-
- prefix_policy - -
- string -
- 		- -
Perform add-path only for prefixes that match policy.
-
-
- aggregate_label - -
- dictionary -
- 		- -
Aggregate labels of incoming routes with the same FEC.
-
-
- community - -
- string -
- 		- -
Community to identify the FEC of incoming routesC.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Aggregate labels of incoming routes with the same FEC
-
-
- aigp - -
- dictionary -
- 		- -
Allow sending and receiving of AIGP attribute.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dn not allow sending and receiving of AIGP attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set AIGP.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- defer_initial_multipath_build - -
- dictionary -
- 		- -
Defer initial multipath build until EOR is received.
-
-
- maximum_delay - -
- integer -
- 		- -
Max delay(sec) multipath build after peer is up.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set defer initial multipath build.
-
-
- delay_route_advertisements - -
- dictionary -
- 		- -
Delay route updates for this family until FIB-sync.
-
-
- max_delay_route_age - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- max_delay_routing_uptime - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- min_delay_inbound_convergence - -
- integer -
- 		- -
Set min delayadvertisement after source-peer sent all routes.
-
-
- min_delay_routing_uptime - -
- integer -
- 		- -
Set min delay advertisement route age.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set delay route advertisements.
-
-
- entropy_label - -
- dictionary -
- 		- -
Use entropy label for entropy label capable BGP LSPs.
-
-
- import - -
- string -
- 		- -
Policy to select BGP LSPs to use entropy label.
-
-
- no_next_hop_validation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't validate next hop field against route next hop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set entropy-label attribute.
-
-
- explicit_null - -
- dictionary -
- 		- -
Advertise explicit null.
-
-
- connected_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise explicit null only for connected routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set explicit-null attribute.
-
-
- extended_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable extended nexthop encoding.
-
-
- extended_nexthop_color - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve using extended color nexthop.
-
-
- graceful_restart_forwarding_state_bit - -
- string -
- 		-
    Choices: -
  • from-fib
    • -
  • set
    • -
- 		-
Specify BGP graceful restart options.
-
-
- legacy_redirect_ip_action - -
- dictionary -
- 		- -
Configure legacy redirect to IP support.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accept legacy encoded redirect-to-ip action attribute
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Redirect action as legacy redirect attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the legacy-redirect-ip-action.
-
-
- local_ipv4_address - -
- string -
- 		- -
Specify local IPv4 address.
-
-
- loops - -
- integer -
- 		- -
Allow local AS in received AS paths.
-
-
- no_install - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dont install received routes in forwarding.
-
-
- no_validate - -
- string -
- 		- -
Bypass validation procedure for routes that match policy.
-
-
- output_queue_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- output_queue_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- per_group_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise prefixes with unique labels per group.
-
-
- per_prefix_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allocate a unique label to each advertised prefix.
-
-
- prefix_limit - -
- dictionary -
- 		- -
Limit maximum number of prefixes from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- resolve_vpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Install received NLRI in inet.3 also.
-
-
- rib - -
- string -
- 		-
    Choices: -
  • inet.3
    • -
- 		-
Select table used by labeled unicast routes.
-
-
- ribgroup_name - -
- string -
- 		- -
Name of the routing table group.
-
-
- route_refresh_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- route_refresh_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- secondary_independent_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve FLOW routes in VRF table independent of VPN FLOW route.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set NLRI.
-
-
- strip_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Strip the next-hop from the outgoing flow update.
-
-
- topology - -
- list - / elements=dictionary -
- 		- -
Multi topology routing tables.
-
-
- community - -
- list - / elements=string -
- 		- -
Community to identify multi topology routes.
-
-
- name - -
- string -
- 		- -
Specify topology name.
-
-
- traffic_statistics - -
- dictionary -
- 		- -
Collect statistics for BGP label-switched paths
-
-
- file - -
- dictionary -
- 		- -
Statistics file options.
-
-
- filename - -
- string -
- 		- -
Name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- interval - -
- integer -
- 		- -
Time to collect statistics (seconds).
-
-
- labeled_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable ingress labeled path statistics.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set traffic-statistics.
-
-
- type - -
- string -
- 		-
    Choices: -
  • any
    • -
  • flow
    • -
  • labeled-unicast
    • -
  • multicast
    • -
  • segment-routing-te
    • -
  • unicast
    • -
  • signaling
    • -
  • auto-discovery-mspw
    • -
  • auto-discovery-only
    • -
- 		-
Specify type of NLRI.
-
-
- withdraw_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- withdraw_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • evpn
    • -
  • inet
    • -
  • inet-mdt
    • -
  • inet-mvpn
    • -
  • inet-vpn
    • -
  • inet6
    • -
  • inet6-mvpn
    • -
  • inet6-vpn
    • -
  • iso-vpn
    • -
  • l2vpn
    • -
  • route-target
    • -
  • traffic-engineering
    • -
- 		-
address family.
-
-
- groups - -
- list - / elements=dictionary -
- 		- -
Specify address family config for groups.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Enable address family and enter its config mode.
-
-
- af_type - -
- list - / elements=dictionary -
- 		- -
Address family type for ipv4.
-
-
- accepted_prefix_limit - -
- dictionary -
- 		- -
Specify limit for maximum number of prefixes accepted from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Specify teardown percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes accepted from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- add_path - -
- dictionary -
- 		- -
Advertise multiple paths to peer.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Receive multiple paths from peer.
-
-
- send - -
- dictionary -
- 		- -
Send multiple paths to peer.
-
-
- include_backup_path - -
- integer -
- 		- -
Specify number of backup paths to advertise.
-
-
- multipath - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include only multipath contributor routes.
-
-
- path_count - -
- integer - / required -
- 		- -
Include only multipath contributor routes.
-
-
- path_selection_mode - -
- dictionary -
- 		- -
Configure how to select add-path routes.
-
-
- all_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise all paths allowed by path count.
-
-
- equal_cost_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise equal cost paths.
-
-
- prefix_policy - -
- string -
- 		- -
Perform add-path only for prefixes that match policy.
-
-
- aggregate_label - -
- dictionary -
- 		- -
Aggregate labels of incoming routes with the same FEC.
-
-
- community - -
- string -
- 		- -
Community to identify the FEC of incoming routesC.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Aggregate labels of incoming routes with the same FEC
-
-
- aigp - -
- dictionary -
- 		- -
Allow sending and receiving of AIGP attribute.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dn not allow sending and receiving of AIGP attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set AIGP.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- defer_initial_multipath_build - -
- dictionary -
- 		- -
Defer initial multipath build until EOR is received.
-
-
- maximum_delay - -
- integer -
- 		- -
Max delay(sec) multipath build after peer is up.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set defer initial multipath build.
-
-
- delay_route_advertisements - -
- dictionary -
- 		- -
Delay route updates for this family until FIB-sync.
-
-
- max_delay_route_age - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- max_delay_routing_uptime - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- min_delay_inbound_convergence - -
- integer -
- 		- -
Set min delayadvertisement after source-peer sent all routes.
-
-
- min_delay_routing_uptime - -
- integer -
- 		- -
Set min delay advertisement route age.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set delay route advertisements.
-
-
- entropy_label - -
- dictionary -
- 		- -
Use entropy label for entropy label capable BGP LSPs.
-
-
- import - -
- string -
- 		- -
Policy to select BGP LSPs to use entropy label.
-
-
- no_next_hop_validation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't validate next hop field against route next hop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set entropy-label attribute.
-
-
- explicit_null - -
- dictionary -
- 		- -
Advertise explicit null.
-
-
- connected_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise explicit null only for connected routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set explicit-null attribute.
-
-
- extended_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable extended nexthop encoding.
-
-
- extended_nexthop_color - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve using extended color nexthop.
-
-
- graceful_restart_forwarding_state_bit - -
- string -
- 		-
    Choices: -
  • from-fib
    • -
  • set
    • -
- 		-
Specify BGP graceful restart options.
-
-
- legacy_redirect_ip_action - -
- dictionary -
- 		- -
Configure legacy redirect to IP support.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accept legacy encoded redirect-to-ip action attribute
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Redirect action as legacy redirect attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the legacy-redirect-ip-action.
-
-
- local_ipv4_address - -
- string -
- 		- -
Specify local IPv4 address.
-
-
- loops - -
- integer -
- 		- -
Allow local AS in received AS paths.
-
-
- no_install - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dont install received routes in forwarding.
-
-
- no_validate - -
- string -
- 		- -
Bypass validation procedure for routes that match policy.
-
-
- output_queue_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- output_queue_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- per_group_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise prefixes with unique labels per group.
-
-
- per_prefix_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allocate a unique label to each advertised prefix.
-
-
- prefix_limit - -
- dictionary -
- 		- -
Limit maximum number of prefixes from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- resolve_vpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Install received NLRI in inet.3 also.
-
-
- rib - -
- string -
- 		-
    Choices: -
  • inet.3
    • -
- 		-
Select table used by labeled unicast routes.
-
-
- ribgroup_name - -
- string -
- 		- -
Name of the routing table group.
-
-
- route_refresh_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- route_refresh_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- secondary_independent_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve FLOW routes in VRF table independent of VPN FLOW route.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set NLRI.
-
-
- strip_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Strip the next-hop from the outgoing flow update.
-
-
- topology - -
- list - / elements=dictionary -
- 		- -
Multi topology routing tables.
-
-
- community - -
- list - / elements=string -
- 		- -
Community to identify multi topology routes.
-
-
- name - -
- string -
- 		- -
Specify topology name.
-
-
- traffic_statistics - -
- dictionary -
- 		- -
Collect statistics for BGP label-switched paths
-
-
- file - -
- dictionary -
- 		- -
Statistics file options.
-
-
- filename - -
- string -
- 		- -
Name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- interval - -
- integer -
- 		- -
Time to collect statistics (seconds).
-
-
- labeled_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable ingress labeled path statistics.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set traffic-statistics.
-
-
- type - -
- string -
- 		-
    Choices: -
  • any
    • -
  • flow
    • -
  • labeled-unicast
    • -
  • multicast
    • -
  • segment-routing-te
    • -
  • unicast
    • -
  • signaling
    • -
  • auto-discovery-mspw
    • -
  • auto-discovery-only
    • -
- 		-
Specify type of NLRI.
-
-
- withdraw_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- withdraw_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • evpn
    • -
  • inet
    • -
  • inet-mdt
    • -
  • inet-mvpn
    • -
  • inet-vpn
    • -
  • inet6
    • -
  • inet6-mvpn
    • -
  • inet6-vpn
    • -
  • iso-vpn
    • -
  • l2vpn
    • -
  • route-target
    • -
  • traffic-engineering
    • -
- 		-
address family.
-
-
- name - -
- string -
- 		- -
Specify name of the group
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Specify address family config per neighbor.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Enable address family and enter its config mode.
-
-
- af_type - -
- list - / elements=dictionary -
- 		- -
Address family type for ipv4.
-
-
- accepted_prefix_limit - -
- dictionary -
- 		- -
Specify limit for maximum number of prefixes accepted from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Specify teardown percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes accepted from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- add_path - -
- dictionary -
- 		- -
Advertise multiple paths to peer.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Receive multiple paths from peer.
-
-
- send - -
- dictionary -
- 		- -
Send multiple paths to peer.
-
-
- include_backup_path - -
- integer -
- 		- -
Specify number of backup paths to advertise.
-
-
- multipath - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include only multipath contributor routes.
-
-
- path_count - -
- integer - / required -
- 		- -
Include only multipath contributor routes.
-
-
- path_selection_mode - -
- dictionary -
- 		- -
Configure how to select add-path routes.
-
-
- all_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise all paths allowed by path count.
-
-
- equal_cost_paths - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise equal cost paths.
-
-
- prefix_policy - -
- string -
- 		- -
Perform add-path only for prefixes that match policy.
-
-
- aggregate_label - -
- dictionary -
- 		- -
Aggregate labels of incoming routes with the same FEC.
-
-
- community - -
- string -
- 		- -
Community to identify the FEC of incoming routesC.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Aggregate labels of incoming routes with the same FEC
-
-
- aigp - -
- dictionary -
- 		- -
Allow sending and receiving of AIGP attribute.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dn not allow sending and receiving of AIGP attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set AIGP.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- defer_initial_multipath_build - -
- dictionary -
- 		- -
Defer initial multipath build until EOR is received.
-
-
- maximum_delay - -
- integer -
- 		- -
Max delay(sec) multipath build after peer is up.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set defer initial multipath build.
-
-
- delay_route_advertisements - -
- dictionary -
- 		- -
Delay route updates for this family until FIB-sync.
-
-
- max_delay_route_age - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- max_delay_routing_uptime - -
- integer -
- 		- -
Set max delay advertisement route age.
-
-
- min_delay_inbound_convergence - -
- integer -
- 		- -
Set min delayadvertisement after source-peer sent all routes.
-
-
- min_delay_routing_uptime - -
- integer -
- 		- -
Set min delay advertisement route age.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set delay route advertisements.
-
-
- entropy_label - -
- dictionary -
- 		- -
Use entropy label for entropy label capable BGP LSPs.
-
-
- import - -
- string -
- 		- -
Policy to select BGP LSPs to use entropy label.
-
-
- no_next_hop_validation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't validate next hop field against route next hop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set entropy-label attribute.
-
-
- explicit_null - -
- dictionary -
- 		- -
Advertise explicit null.
-
-
- connected_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise explicit null only for connected routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set explicit-null attribute.
-
-
- extended_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable extended nexthop encoding.
-
-
- extended_nexthop_color - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve using extended color nexthop.
-
-
- graceful_restart_forwarding_state_bit - -
- string -
- 		-
    Choices: -
  • from-fib
    • -
  • set
    • -
- 		-
Specify BGP graceful restart options.
-
-
- legacy_redirect_ip_action - -
- dictionary -
- 		- -
Configure legacy redirect to IP support.
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accept legacy encoded redirect-to-ip action attribute
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Redirect action as legacy redirect attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the legacy-redirect-ip-action.
-
-
- local_ipv4_address - -
- string -
- 		- -
Specify local IPv4 address.
-
-
- loops - -
- integer -
- 		- -
Allow local AS in received AS paths.
-
-
- no_install - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dont install received routes in forwarding.
-
-
- no_validate - -
- string -
- 		- -
Bypass validation procedure for routes that match policy.
-
-
- output_queue_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- output_queue_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- per_group_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise prefixes with unique labels per group.
-
-
- per_prefix_label - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allocate a unique label to each advertised prefix.
-
-
- prefix_limit - -
- dictionary -
- 		- -
Limit maximum number of prefixes from a peer.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- idle_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set idle timeout node.
-
-
- idle_timeout_value - -
- integer -
- 		- -
Specify timeout before attempting to restart peer.
-
-
- limit_threshold - -
- integer -
- 		- -
Percentage of prefix-limit to start warnings.
-
-
- maximum - -
- integer -
- 		- -
Specify maximum number of prefixes from a peer.
-
-
- teardown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clear peer connection on reaching limit.
-
-
- resolve_vpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Install received NLRI in inet.3 also.
-
-
- rib - -
- string -
- 		-
    Choices: -
  • inet.3
    • -
- 		-
Select table used by labeled unicast routes.
-
-
- ribgroup_name - -
- string -
- 		- -
Name of the routing table group.
-
-
- route_refresh_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- route_refresh_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- secondary_independent_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Resolve FLOW routes in VRF table independent of VPN FLOW route.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set NLRI.
-
-
- strip_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Strip the next-hop from the outgoing flow update.
-
-
- topology - -
- list - / elements=dictionary -
- 		- -
Multi topology routing tables.
-
-
- community - -
- list - / elements=string -
- 		- -
Community to identify multi topology routes.
-
-
- name - -
- string -
- 		- -
Specify topology name.
-
-
- traffic_statistics - -
- dictionary -
- 		- -
Collect statistics for BGP label-switched paths
-
-
- file - -
- dictionary -
- 		- -
Statistics file options.
-
-
- filename - -
- string -
- 		- -
Name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- interval - -
- integer -
- 		- -
Time to collect statistics (seconds).
-
-
- labeled_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable ingress labeled path statistics.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set traffic-statistics.
-
-
- type - -
- string -
- 		-
    Choices: -
  • any
    • -
  • flow
    • -
  • labeled-unicast
    • -
  • multicast
    • -
  • segment-routing-te
    • -
  • unicast
    • -
  • signaling
    • -
  • auto-discovery-mspw
    • -
  • auto-discovery-only
    • -
- 		-
Specify type of NLRI.
-
-
- withdraw_priority_expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- withdraw_priority_priority - -
- integer -
- 		- -
Output queue priority; higher is better.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • evpn
    • -
  • inet
    • -
  • inet-mdt
    • -
  • inet-mvpn
    • -
  • inet-vpn
    • -
  • inet6
    • -
  • inet6-mvpn
    • -
  • inet6-vpn
    • -
  • iso-vpn
    • -
  • l2vpn
    • -
  • route-target
    • -
  • traffic-engineering
    • -
- 		-
address family.
-
-
- neighbor_address - -
- string -
- 		- -
Specify neighbor address.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show protocols bgp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State deleted only removes BGP address family attributes that this modules manages and does not negate the BGP neighbor address family completely. Thereby, preserving address-family related configurations under BGP group neighbor context.
-
To delete the address family associated to neighbor use junipernetworks.junos.junos_bgp_neighbor_address_family modules for prior cleanup.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state - # ------------ - # - # admin# show protocols bgp - # - # [edit] - - - name: Merge Junos BGP address family configuration - junipernetworks.junos.junos_bgp_address_family: - config: - address_family: - - afi: 'evpn' - af_type: - - type: 'signaling' - accepted_prefix_limit: - maximum: 20 - limit_threshold: 98 - idle_timeout_value: 2001 - damping: true - defer_initial_multipath_build: - maximum_delay: 2 - - afi: 'inet' - af_type: - - type: 'flow' - legacy_redirect_ip_action: - send: true - receive: true - loops: 4 - no_install: true - output_queue_priority_expedited: true - secondary_independent_resolution: true - - - type: 'unicast' - extended_nexthop: true - extended_nexthop_color: true - local_ipv4_address: '9.9.9.9' - - - type: 'labeled-unicast' - entropy_label: - no_next_hop_validation: true - explicit_null: - connected_only: true - per_prefix_label: true - per_group_label: true - prefix_limit: - maximum: 20 - limit_threshold: 99 - forever: true - resolve_vpn: true - rib: 'inet.3' - route_refresh_priority_expedited: true - route_refresh_priority_priority: 3 - - - type: 'any' - accepted_prefix_limit: - maximum: 20 - limit_threshold: 99 - idle_timeout_value: 2000 - damping: true - defer_initial_multipath_build: - maximum_delay: 2 - delay_route_advertisements: - max_delay_route_age: 20 - max_delay_routing_uptime: 32000 - min_delay_inbound_convergence: 32000 - min_delay_routing_uptime: 23000 - graceful_restart_forwarding_state_bit: 'from-fib' - state: merged - - # Task Output: - # ------------ - # - # before: {} - # - # commands: - # - - # 2098 - # 2001 - # 2 - # - # 4 - # - # 9.9.9.9 - # - # - # 2099 - # - # 3 - # 2099 - # 2000 - # 2 - # 2032000 - # 32000 - # 23000 - # from-fib - # - # - - # - # after: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - - # After state - # ----------- - # - # admin# show protocols bgp - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - # - # Using replaced - # - # Before state - # ------------ - # - # admin# show protocols bgp - # preference 2; - # hold-time 5; - # advertise-inactive; - # out-delay 10; - # bgp-error-tolerance { - # malformed-route-limit 40000000; - # } - # authentication-algorithm md5; - # advertise-bgp-static { - # policy static-to-bgp; - # } - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - - name: Replace existing Junos BGP address family config with provided config - junipernetworks.junos.junos_bgp_address_family: - config: - address_family: - - afi: 'evpn' - af_type: - - type: 'signaling' - accepted_prefix_limit: - maximum: 21 - limit_threshold: 99 - idle_timeout_value: 2002 - delay_route_advertisements: - max_delay_route_age: 20 - max_delay_routing_uptime: 32000 - min_delay_inbound_convergence: 32000 - min_delay_routing_uptime: 23000 - damping: true - state: replaced - - # Task Output: - # ------------ - # - # before: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - # - # commands: - # - - # - # 2199 - # 2002 - # 20 - # 32000 - # 3200023000 - # - # - - # - # after: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2002 - # limit_threshold: 99 - # maximum: 21 - # damping: true - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - # - # After state - # ----------- - # - # admin# show protocols bgp - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 21; - # teardown 99 idle-timeout 2002; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # } - # } - - # Using overridden - # - # Before state - # ------------ - # - # admin# show protocols bgp - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - - name: Override Junos BGP address family config - junipernetworks.junos.junos_bgp_address_family: - config: - address_family: - - afi: 'evpn' - af_type: - - type: 'signaling' - accepted_prefix_limit: - maximum: 21 - limit_threshold: 99 - idle_timeout_value: 2002 - delay_route_advertisements: - max_delay_route_age: 20 - max_delay_routing_uptime: 32000 - min_delay_inbound_convergence: 32000 - min_delay_routing_uptime: 23000 - damping: true - state: overridden - - # Task Output: - # ------------ - # - # before: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2002 - # limit_threshold: 99 - # maximum: 21 - # damping: true - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - # - # commands: - # - - # - # 21 - # 992002 - # - # 2032000 - # 32000 - # 23000 - # - # - - # - # After state - # ----------- - # - # admin# show protocols bgp - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 21; - # teardown 99 idle-timeout 2002; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # } - # } - - # Using deleted - # - # Before state - # ------------ - # - # admin# show protocols bgp - # preference 2; - # hold-time 5; - # advertise-inactive; - # out-delay 10; - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - - name: Delete Junos BGP address family config based on the afi - junipernetworks.junos.junos_bgp_address_family: - config: - address_family: - - afi: 'inet' - state: deleted - - # Task Output: - # ------------ - # - # before: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - # - # commands: - # - - # - # - - # - # after: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - # After state - # ----------- - # - # admin# show protocols bgp - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - # Using deleted - # - # Before state - # ------------ - # - # admin# show protocols bgp - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - - name: Delete complete Junos BGP address family config - junipernetworks.junos.junos_bgp_address_family: - config: - state: deleted - - # Task Output: - # ------------ - # - # before: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - # commands: - # - - # - # - # - - # - # after: {} - - # After state - # ----------- - # - # admin# show protocols bgp - # - - # Using gathered - # - # Before state - # ------------ - # - # admin# show protocols bgp - # family inet { - # unicast { - # local-ipv4-address 9.9.9.9; - # extended-nexthop; - # extended-nexthop-color; - # } - # flow { - # loops 4; - # no-install; - # output-queue-priority expedited; - # legacy-redirect-ip-action { - # receive; - # send; - # } - # secondary-independent-resolution; - # } - # any { - # accepted-prefix-limit { - # maximum 20; - # teardown 99 idle-timeout 2000; - # } - # damping; - # delay-route-advertisements { - # minimum-delay { - # routing-uptime 23000; - # inbound-convergence 32000; - # } - # maximum-delay { - # route-age 20; - # routing-uptime 32000; - # } - # } - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # graceful-restart { - # forwarding-state-bit from-fib; - # } - # } - # labeled-unicast { - # prefix-limit { - # maximum 20; - # teardown 99 idle-timeout forever; - # } - # route-refresh-priority priority 3; - # per-prefix-label; - # per-group-label; - # rib { - # inet.3; - # } - # explicit-null connected-only; - # resolve-vpn; - # entropy-label { - # no-next-hop-validation; - # } - # } - # } - # family evpn { - # signaling { - # accepted-prefix-limit { - # maximum 20; - # teardown 98 idle-timeout 2001; - # } - # damping; - # defer-initial-multipath-build { - # maximum-delay 2; - # } - # } - # } - - - name: Gather Junos BGP address family config - junipernetworks.junos.junos_bgp_address_family: - config: - state: gathered - # - # - # Task Output: - # ------------ - # - # gathered: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # 2 - # 5 - # - # 10 - # - # - # - # 9.9.9.9 - # - # - # - # - # - # 4 - # - # - # - # - # - # - # - # - # - # - # - # - # - # 20 - # - # 99 - # - # 2000 - # - # - # - # - # - # - # 23000 - # 32000 - # - # - # 20 - # 32000 - # - # - # - # 2 - # - # - # from-fib - # - # - # - # - # 20 - # - # 99 - # - # - # - # - # - # - # 3 - # - # - # - # - # - # - # - # - # - # - # - # - # - # - # - # - # - # - # 20 - # - # 98 - # - # 2001 - # - # - # - # - # - # 2 - # - # - # - # - # - # - # - # 0.0.0.100 - # - # 200 - # - # - # so-0/0/0.0 - # 5 - # 3 - # - # - # - # - # - # - # - # 172.16.17.0/24 - # - # - # - # 10.200.16.75 - # - # 65432 - # - # - # - # - - - - name: Parsed the bgp address family running config to get the facts - junipernetworks.junos.junos_bgp_address_family: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - # - # Task Output: - # ------------ - # - # parsed: - # address_family: - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2001 - # limit_threshold: 98 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # type: signaling - # afi: evpn - # - af_type: - # - accepted_prefix_limit: - # idle_timeout_value: 2000 - # limit_threshold: 99 - # maximum: 20 - # damping: true - # defer_initial_multipath_build: - # maximum_delay: 2 - # delay_route_advertisements: - # max_delay_route_age: 20 - # max_delay_routing_uptime: 32000 - # min_delay_inbound_convergence: 32000 - # min_delay_routing_uptime: 23000 - # graceful_restart_forwarding_state_bit: from-fib - # type: any - # - legacy_redirect_ip_action: - # receive: true - # send: true - # loops: 4 - # no_install: true - # output_queue_priority_expedited: true - # secondary_independent_resolution: true - # type: flow - # - entropy_label: - # no_next_hop_validation: true - # explicit_null: - # connected_only: true - # per_group_label: true - # per_prefix_label: true - # prefix_limit: - # forever: true - # limit_threshold: 99 - # maximum: 20 - # resolve_vpn: true - # rib: inet.3 - # route_refresh_priority_priority: 3 - # type: labeled-unicast - # - extended_nexthop: true - # extended_nexthop_color: true - # local_ipv4_address: 9.9.9.9 - # type: unicast - # afi: inet - - # Using rendered - # - - name: Render the commands for provided configuration - junipernetworks.junos.junos_bgp_address_family: - config: - address_family: - - afi: 'evpn' - af_type: - - type: 'signaling' - accepted_prefix_limit: - maximum: 20 - limit_threshold: 98 - idle_timeout_value: 2001 - damping: true - defer_initial_multipath_build: - maximum_delay: 2 - - afi: 'inet' - af_type: - - type: 'flow' - legacy_redirect_ip_action: - send: true - receive: true - loops: 4 - no_install: true - output_queue_priority_expedited: true - secondary_independent_resolution: true - - - type: 'unicast' - extended_nexthop: true - extended_nexthop_color: true - local_ipv4_address: '9.9.9.9' - - - type: 'labeled-unicast' - entropy_label: - no_next_hop_validation: true - explicit_null: - connected_only: true - per_prefix_label: true - per_group_label: true - prefix_limit: - maximum: 20 - limit_threshold: 99 - forever: true - resolve_vpn: true - rib: 'inet.3' - route_refresh_priority_expedited: true - route_refresh_priority_priority: 3 - - - type: 'any' - accepted_prefix_limit: - maximum: 20 - limit_threshold: 99 - idle_timeout_value: 2000 - damping: true - defer_initial_multipath_build: - maximum_delay: 2 - delay_route_advertisements: - max_delay_route_age: 20 - max_delay_routing_uptime: 32000 - min_delay_inbound_convergence: 32000 - min_delay_routing_uptime: 23000 - graceful_restart_forwarding_state_bit: 'from-fib' - state: rendered - - # Task Output: - # ------------ - # - # rendered: " - # 20 - # 982001 - # - # 2 - # - # 4 - # - # - # 9.9.9.9 - # - # - # 20 - # 99 - # - # 3 - # 20 - # 992000 - # - # 2 - # - # 2032000 - # 32000 - # 23000 - # from-fib - # " - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:bgp><nc:family><nc:evpn><nc:signaling><nc:accepted-prefix-limit> <nc:maximum>21</nc:maximum><nc:teardown><nc:limit-threshold>99</nc:limit-threshold> <nc:idle-timeout><nc:timeout>2002</nc:timeout></nc:idle-timeout> </nc:teardown></nc:accepted-prefix-limit><nc:damping/> <nc:delay-route-advertisements><nc:maximum-delay> <nc:route-age>20</nc:route-age><nc:routing-uptime>32000</nc:routing-uptime> </nc:maximum-delay><nc:minimum-delay><nc:inbound-convergence>32000</nc:inbound-convergence> <nc:routing-uptime>23000</nc:routing-uptime></nc:minimum-delay></nc:delay-route-advertisements> </nc:signaling></nc:evpn></nc:family></nc:bgp></nc:protocols>', 'xml 2', 'xml 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_bgp_global_module.rst b/docs/junipernetworks.junos.junos_bgp_global_module.rst deleted file mode 100644 index e116888b..00000000 --- a/docs/junipernetworks.junos.junos_bgp_global_module.rst +++ /dev/null @@ -1,11520 +0,0 @@ -.. _junipernetworks.junos.junos_bgp_global_module: - - -************************************** -junipernetworks.junos.junos_bgp_global -************************************** - -**Manages BGP Global configuration on devices running Juniper JUNOS.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages global bgp configuration on devices running Juniper JUNOS. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP process configuration.
-
-
- accept_remote_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow import policy to specify a non-directly connected next-hop.
-
-
- add_path_display_ipv4_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display add-path path-id in IPv4 address format.
-
-
- advertise_bgp_static - -
- dictionary -
- 		- -
Advertise bgp-static routes.
-
-
- policy - -
- string -
- 		- -
Specify static route advertisement policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise bgp-static routes.
-
-
- advertise_external - -
- dictionary -
- 		- -
Advertise best external routes.
-
-
- conditional - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Route matches active route upto med-comparison rule.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise best external routes.
-
-
- advertise_from_main_vpn_tables - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise VPN routes from bgp.Xvpn.0 tables in master instance.
-
-
- advertise_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise inactive routes.
-
-
- advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise routes received from the same autonomous system.
-
-
- as_number - -
- string -
- 		- -
Specify Autonomous system number.
-
-
- asdot_notation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable AS-Dot notation to display true 4 byte AS numbers.
-
-
- authentication_algorithm - -
- string -
- 		-
    Choices: -
  • aes-128-cmac-96
    • -
  • hmac-sha-1-96
    • -
  • md5
    • -
- 		-
Specify authentication algorithm name.
-
-
- authentication_key - -
- string -
- 		- -
Specify MD5 authentication key.
-
-
- authentication_key_chain - -
- string -
- 		- -
Specify authentication key chain name.
-
-
- bfd_liveness_detection - -
- dictionary -
- 		- -
Bidirectional Forwarding Detection (BFD) options.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication options.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • keyed-md5
    • -
  • keyed-sha-1
    • -
  • meticulous-keyed-md5
    • -
  • meticulous-keyed-sha-1
    • -
  • simple-password
    • -
- 		-
Specify algorithm name.
-
-
- key_chain - -
- string -
- 		- -
Specify Key chain name.
-
-
- loose_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Verify authentication only if authentication is negotiated.
-
-
- detection_time - -
- dictionary -
- 		- -
Specify Detection-time optionss.
-
-
- threshold - -
- integer -
- 		- -
Specify high detection-time triggering a trap (milliseconds).
-
-
- holddown_interval - -
- integer -
- 		- -
Specify time to hold the session-UP notification to the client.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify minimum transmit and receive interval.
-
-
- minimum_receive_interval - -
- integer -
- 		- -
Specify minimum receive interval.
-
-
- multiplier - -
- integer -
- 		- -
Specify detection time multiplier.
-
-
- no_adaptation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable adaptation.
-
-
- session_mode - -
- string -
- 		-
    Choices: -
  • automatic
    • -
  • multihop
    • -
  • single-hop
    • -
- 		-
BFD single-hop or multihop session-mode.
-
-
- transmit_interval - -
- dictionary -
- 		- -
Transmit-interval options.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify Minimum transmit interval.
-
-
- threshold - -
- integer -
- 		- -
Specify high transmit interval triggering a trap.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 1
    • -
  • automatic
    • -
- 		-
Specify BFD protocol version number.
-
-
- bgp_error_tolerance - -
- dictionary -
- 		- -
Handle BGP malformed updates softly.
-
-
- malformed_route_limit - -
- integer -
- 		- -
Maximum number of malformed routes from a peer.
-
-
- malformed_update_log_interval - -
- integer -
- 		- -
Time used when logging malformed update.
-
-
- no_malformed_route_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify no malformed route limit.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP malformed updates softly.
-
-
- bmp - -
- dictionary -
- 		- -
Specific settings to override the routing-options settings.
-
-
- monitor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable monitoring.
-
-
- route_monitoring - -
- dictionary -
- 		- -
Control route monitoring settings.
-
-
- none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send route montoring messages.
-
-
- post_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages.
-
-
- post_policy_exclude_non_eligible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages and exclude unresolved routes, etc.
-
-
- post_policy_exclude_non_feasible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages and exclude looped routes, etc.
-
-
- pre_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages.
-
-
- cluster_id - -
- string -
- 		- -
Specify cluster identifier.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- description - -
- string -
- 		- -
Specify text description.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable BGP.
-
-
- egress_te - -
- dictionary -
- 		- -
Use Egress Peering traffic engineering.
-
-
- backup_path - -
- string -
- 		- -
The 'egress-te-backup-paths template' to use for this peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the attribute.
-
-
- egress_te_backup_paths - -
- dictionary -
- 		- -
Backup-path for Egress-TE peer interface failure.
-
-
- templates - -
- list - / elements=dictionary -
- 		- -
Specify Backup-path template.
-
-
- ip_forward - -
- dictionary -
- 		- -
Use IP-forward backup path for Egress TE.
-
-
- rti_name - -
- string -
- 		- -
Routing-instance to use as IP forward backup-path.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set use IP-forward backup path for Egress TE.
-
-
- path_name - -
- string - / required -
- 		- -
Name of Egress-TE backup path.
-
-
- peers - -
- list - / elements=string -
- 		- -
Specify address of BGP peer to use as backup next-hop.
-
-
- remote_nexthop - -
- string -
- 		- -
Specify address of remote-nexthop to use as backup path.
-
-
- egress_te_set_segment - -
- list - / elements=dictionary -
- 		- -
Configure BGP-Peer-Set segment.
-
-
- egress_te_backup_segment_label - -
- integer -
- 		- -
BGP-Peer-Set SID label value from static label pool.
-
-
- label - -
- integer -
- 		- -
Backup segment label value from static label pool.
-
-
- name - -
- string - / required -
- 		- -
The BGP-Peer-Set segment name.
-
-
- egress_te_sid_stats - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Create BGP-Peer-SID sensor.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- export - -
- string -
- 		- -
Specify export policy.
-
-
- forwarding_context - -
- string -
- 		- -
Specify routing-instance used for data-forwarding and transport-session.
-
-
- graceful_restart - -
- dictionary -
- 		- -
BGP graceful restart options.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable graceful restart.
-
-
- dont_help_shared_fate_bfd_down - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor BFD-Down(C=0) if GR-restart not in progress.
-
-
- forwarding_state_bit - -
- dictionary -
- 		- -
Control forwarding-state flag negotiation.
-
-
- as_rr_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
As for a route reflector client.
-
-
- from_fib - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always use state of associated FIs.
-
-
- long_lived - -
- dictionary -
- 		- -
Long-lived graceful restart options.
-
-
- advertise_to_non_llgr_neighbor - -
- dictionary -
- 		- -
Advertise stale routes to non-LLGR neighbors.
-
-
- omit_no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- receiver_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable receiver (helper) functionality.
-
-
- restart_time - -
- integer -
- 		- -
Restart time used when negotiating with a peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP graceful restart options.
-
-
- stale_routes_time - -
- integer -
- 		- -
Maximum time for which stale routes are kept.
-
-
- groups - -
- list - / elements=dictionary -
- 		- -
Specify name of the group.
-
-
- accept_remote_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow import policy to specify a non-directly connected next-hop.
-
-
- add_path_display_ipv4_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display add-path path-id in IPv4 address format.
-
-
- advertise_bgp_static - -
- dictionary -
- 		- -
Advertise bgp-static routes.
-
-
- policy - -
- string -
- 		- -
Specify static route advertisement policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise bgp-static routes.
-
-
- advertise_external - -
- dictionary -
- 		- -
Advertise best external routes.
-
-
- conditional - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Route matches active route upto med-comparison rule.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise best external routes.
-
-
- advertise_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise inactive routes.
-
-
- advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise routes received from the same autonomous system.
-
-
- allow - -
- list - / elements=string -
- 		- -
Configure peer connections for specific networks.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace neighbor AS number with our AS number
-
-
- authentication_algorithm - -
- string -
- 		-
    Choices: -
  • aes-128-cmac-96
    • -
  • hmac-sha-1-96
    • -
  • md5
    • -
- 		-
Specify authentication algorithm name.
-
-
- authentication_key - -
- string -
- 		- -
Specify MD5 authentication key.
-
-
- authentication_key_chain - -
- string -
- 		- -
Specify authentication key chain name.
-
-
- bfd_liveness_detection - -
- dictionary -
- 		- -
Bidirectional Forwarding Detection (BFD) options.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication options.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • keyed-md5
    • -
  • keyed-sha-1
    • -
  • meticulous-keyed-md5
    • -
  • meticulous-keyed-sha-1
    • -
  • simple-password
    • -
- 		-
Specify algorithm name.
-
-
- key_chain - -
- string -
- 		- -
Specify Key chain name.
-
-
- loose_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Verify authentication only if authentication is negotiated.
-
-
- detection_time - -
- dictionary -
- 		- -
Specify Detection-time optionss.
-
-
- threshold - -
- integer -
- 		- -
Specify high detection-time triggering a trap (milliseconds).
-
-
- holddown_interval - -
- integer -
- 		- -
Specify time to hold the session-UP notification to the client.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify minimum transmit and receive interval.
-
-
- minimum_receive_interval - -
- integer -
- 		- -
Specify minimum receive interval.
-
-
- multiplier - -
- integer -
- 		- -
Specify detection time multiplier.
-
-
- no_adaptation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable adaptation.
-
-
- session_mode - -
- string -
- 		-
    Choices: -
  • automatic
    • -
  • multihop
    • -
  • single-hop
    • -
- 		-
BFD single-hop or multihop session-mode.
-
-
- transmit_interval - -
- dictionary -
- 		- -
Transmit-interval options.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify Minimum transmit interval.
-
-
- threshold - -
- integer -
- 		- -
Specify high transmit interval triggering a trap.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 1
    • -
  • automatic
    • -
- 		-
Specify BFD protocol version number.
-
-
- bgp_error_tolerance - -
- dictionary -
- 		- -
Handle BGP malformed updates softly.
-
-
- malformed_route_limit - -
- integer -
- 		- -
Maximum number of malformed routes from a peer.
-
-
- malformed_update_log_interval - -
- integer -
- 		- -
Time used when logging malformed update.
-
-
- no_malformed_route_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify no malformed route limit.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP malformed updates softly.
-
-
- bmp - -
- dictionary -
- 		- -
Specific settings to override the routing-options settings.
-
-
- monitor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable monitoring.
-
-
- route_monitoring - -
- dictionary -
- 		- -
Control route monitoring settings.
-
-
- none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send route montoring messages.
-
-
- post_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages.
-
-
- post_policy_exclude_non_eligible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages and exclude unresolved routes, etc.
-
-
- post_policy_exclude_non_feasible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages and exclude looped routes, etc.
-
-
- pre_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages.
-
-
- cluster_id - -
- string -
- 		- -
Specify cluster identifier.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- description - -
- string -
- 		- -
Specify text description.
-
-
- egress_te - -
- dictionary -
- 		- -
Use Egress Peering traffic engineering.
-
-
- backup_path - -
- string -
- 		- -
The 'egress-te-backup-paths template' to use for this peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the attribute.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- export - -
- string -
- 		- -
Specify export policy.
-
-
- forwarding_context - -
- string -
- 		- -
Specify routing-instance used for data-forwarding and transport-session.
-
-
- graceful_restart - -
- dictionary -
- 		- -
BGP graceful restart options.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable graceful restart.
-
-
- dont_help_shared_fate_bfd_down - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor BFD-Down(C=0) if GR-restart not in progress.
-
-
- forwarding_state_bit - -
- dictionary -
- 		- -
Control forwarding-state flag negotiation.
-
-
- as_rr_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
As for a route reflector client.
-
-
- from_fib - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always use state of associated FIs.
-
-
- long_lived - -
- dictionary -
- 		- -
Long-lived graceful restart options.
-
-
- advertise_to_non_llgr_neighbor - -
- dictionary -
- 		- -
Advertise stale routes to non-LLGR neighbors.
-
-
- omit_no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- receiver_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable receiver (helper) functionality.
-
-
- restart_time - -
- integer -
- 		- -
Restart time used when negotiating with a peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP graceful restart options.
-
-
- stale_routes_time - -
- integer -
- 		- -
Maximum time for which stale routes are kept.
-
-
- hold_time - -
- integer -
- 		- -
Specify hold time used when negotiating with a peer.
-
-
- idle_after_switch_over - -
- dictionary -
- 		- -
Stop peer session from coming up after nonstop-routing switch-over.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- timeout - -
- integer -
- 		- -
Specify timeout value, in seconds, for starting peer after switch over.
-
-
- import - -
- list - / elements=string -
- 		- -
Specify import policy.
-
-
- include_mp_next_hop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include NEXT-HOP attribute in multiprotocol updates.
-
-
- ipsec_sa - -
- string -
- 		- -
Specify IPSec SA name.
-
-
- keep - -
- string -
- 		-
    Choices: -
  • all
    • -
  • none
    • -
- 		-
Specify how to retain routes in the routing table.
-
-
- local_address - -
- string -
- 		- -
Specify Address of local end of BGP session.
-
-
- local_as - -
- dictionary -
- 		- -
Local autonomous system number.
-
-
- alias - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat this AS as an alias to the system AS.
-
-
- as_num - -
- string - / required -
- 		- -
Autonomous system number in plain number or (asdot notation) format.
-
-
- loops - -
- integer -
- 		- -
Maximum number of times this AS can be in an AS path.
-
-
- no_prepend_global_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maximum number of times this AS can be in an AS path.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hide this local AS in paths learned from this peering.
-
-
- local_interface - -
- string -
- 		- -
Specify Local interface for IPv6 link local EBGP peering.
-
-
- local_preference - -
- string -
- 		- -
Specify value of LOCAL_PREF path attribute.
-
-
- log_updown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable log a message for peer state transitions.
-
-
- metric_out - -
- dictionary -
- 		- -
Specify route metric sent in MED.
-
-
- igp - -
- dictionary -
- 		- -
Track the IGP metric.
-
-
- delay_med_update - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delay updating MED when IGP metric increases.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the IGP metric.
-
-
- metric_value - -
- integer -
- 		- -
Specify metric value.
-
-
- minimum_igp - -
- dictionary -
- 		- -
Track the minimum IGP metric.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the minimum IGP metric.
-
-
- mtu_discovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable TCP path MTU discovery.
-
-
- multihop - -
- dictionary -
- 		- -
Configure an EBGP multihop session.
-
-
- no_nexthop_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not change next hop to self in advertisements.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set an EBGP multihop session.
-
-
- ttl - -
- integer -
- 		- -
TTL value for the session.
-
-
- multipath - -
- dictionary -
- 		- -
Allow load sharing among multiple BGP paths.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable Multipath.
-
-
- multiple_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use paths received from different ASs.
-
-
- multiple_as_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable multipath.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set allow load sharing among multiple BGP paths.
-
-
- name - -
- string -
- 		- -
Specify the name of the group
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Specify list of neighbors.
-
-
- accept_remote_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow import policy to specify a non-directly connected next-hop.
-
-
- add_path_display_ipv4_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display add-path path-id in IPv4 address format.
-
-
- advertise_bgp_static - -
- dictionary -
- 		- -
Advertise bgp-static routes.
-
-
- policy - -
- string -
- 		- -
Specify static route advertisement policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise bgp-static routes.
-
-
- advertise_external - -
- dictionary -
- 		- -
Advertise best external routes.
-
-
- conditional - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Route matches active route upto med-comparison rule.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise best external routes.
-
-
- advertise_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise inactive routes.
-
-
- advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise routes received from the same autonomous system.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace neighbor AS number with our AS number
-
-
- authentication_algorithm - -
- string -
- 		-
    Choices: -
  • aes-128-cmac-96
    • -
  • hmac-sha-1-96
    • -
  • md5
    • -
- 		-
Specify authentication algorithm name.
-
-
- authentication_key - -
- string -
- 		- -
Specify MD5 authentication key.
-
-
- authentication_key_chain - -
- string -
- 		- -
Specify authentication key chain name.
-
-
- bfd_liveness_detection - -
- dictionary -
- 		- -
Bidirectional Forwarding Detection (BFD) options.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication options.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • keyed-md5
    • -
  • keyed-sha-1
    • -
  • meticulous-keyed-md5
    • -
  • meticulous-keyed-sha-1
    • -
  • simple-password
    • -
- 		-
Specify algorithm name.
-
-
- key_chain - -
- string -
- 		- -
Specify Key chain name.
-
-
- loose_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Verify authentication only if authentication is negotiated.
-
-
- detection_time - -
- dictionary -
- 		- -
Specify Detection-time optionss.
-
-
- threshold - -
- integer -
- 		- -
Specify high detection-time triggering a trap (milliseconds).
-
-
- holddown_interval - -
- integer -
- 		- -
Specify time to hold the session-UP notification to the client.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify minimum transmit and receive interval.
-
-
- minimum_receive_interval - -
- integer -
- 		- -
Specify minimum receive interval.
-
-
- multiplier - -
- integer -
- 		- -
Specify detection time multiplier.
-
-
- no_adaptation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable adaptation.
-
-
- session_mode - -
- string -
- 		-
    Choices: -
  • automatic
    • -
  • multihop
    • -
  • single-hop
    • -
- 		-
BFD single-hop or multihop session-mode.
-
-
- transmit_interval - -
- dictionary -
- 		- -
Transmit-interval options.
-
-
- minimum_interval - -
- integer -
- 		- -
Specify Minimum transmit interval.
-
-
- threshold - -
- integer -
- 		- -
Specify high transmit interval triggering a trap.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 1
    • -
  • automatic
    • -
- 		-
Specify BFD protocol version number.
-
-
- bgp_error_tolerance - -
- dictionary -
- 		- -
Handle BGP malformed updates softly.
-
-
- malformed_route_limit - -
- integer -
- 		- -
Maximum number of malformed routes from a peer.
-
-
- malformed_update_log_interval - -
- integer -
- 		- -
Time used when logging malformed update.
-
-
- no_malformed_route_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify no malformed route limit.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP malformed updates softly.
-
-
- bmp - -
- dictionary -
- 		- -
Specific settings to override the routing-options settings.
-
-
- monitor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable monitoring.
-
-
- route_monitoring - -
- dictionary -
- 		- -
Control route monitoring settings.
-
-
- none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send route montoring messages.
-
-
- post_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages.
-
-
- post_policy_exclude_non_eligible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send post policy route montoring messages and exclude unresolved routes, etc.
-
-
- post_policy_exclude_non_feasible - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages and exclude looped routes, etc.
-
-
- pre_policy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send pre policy route montoring messages.
-
-
- cluster_id - -
- string -
- 		- -
Specify cluster identifier.
-
-
- damping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route flap damping.
-
-
- description - -
- string -
- 		- -
Specify neighbor description.
-
-
- egress_te - -
- dictionary -
- 		- -
Use Egress Peering traffic engineering.
-
-
- backup_path - -
- string -
- 		- -
The 'egress-te-backup-paths template' to use for this peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the attribute.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- export - -
- string -
- 		- -
Specify export policy.
-
-
- forwarding_context - -
- string -
- 		- -
Specify routing-instance used for data-forwarding and transport-session.
-
-
- graceful_restart - -
- dictionary -
- 		- -
BGP graceful restart options.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable graceful restart.
-
-
- dont_help_shared_fate_bfd_down - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor BFD-Down(C=0) if GR-restart not in progress.
-
-
- forwarding_state_bit - -
- dictionary -
- 		- -
Control forwarding-state flag negotiation.
-
-
- as_rr_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
As for a route reflector client.
-
-
- from_fib - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always use state of associated FIs.
-
-
- long_lived - -
- dictionary -
- 		- -
Long-lived graceful restart options.
-
-
- advertise_to_non_llgr_neighbor - -
- dictionary -
- 		- -
Advertise stale routes to non-LLGR neighbors.
-
-
- omit_no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Advertise stale routes to non-LLGR neighbors.
-
-
- receiver_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable receiver (helper) functionality.
-
-
- restart_time - -
- integer -
- 		- -
Restart time used when negotiating with a peer.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BGP graceful restart options.
-
-
- stale_routes_time - -
- integer -
- 		- -
Maximum time for which stale routes are kept.
-
-
- hold_time - -
- integer -
- 		- -
Specify hold time used when negotiating with a peer.
-
-
- idle_after_switch_over - -
- dictionary -
- 		- -
Stop peer session from coming up after nonstop-routing switch-over.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- timeout - -
- integer -
- 		- -
Specify timeout value, in seconds, for starting peer after switch over.
-
-
- import - -
- list - / elements=string -
- 		- -
Specify import policy.
-
-
- include_mp_next_hop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include NEXT-HOP attribute in multiprotocol updates.
-
-
- ipsec_sa - -
- string -
- 		- -
Specify IPSec SA name.
-
-
- keep - -
- string -
- 		-
    Choices: -
  • all
    • -
  • none
    • -
- 		-
Specify how to retain routes in the routing table.
-
-
- local_address - -
- string -
- 		- -
Specify Address of local end of BGP session.
-
-
- local_as - -
- dictionary -
- 		- -
Local autonomous system number.
-
-
- alias - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat this AS as an alias to the system AS.
-
-
- as_num - -
- string - / required -
- 		- -
Autonomous system number in plain number or (asdot notation) format.
-
-
- loops - -
- integer -
- 		- -
Maximum number of times this AS can be in an AS path.
-
-
- no_prepend_global_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maximum number of times this AS can be in an AS path.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hide this local AS in paths learned from this peering.
-
-
- local_interface - -
- string -
- 		- -
Specify Local interface for IPv6 link local EBGP peering.
-
-
- local_preference - -
- string -
- 		- -
Specify value of LOCAL_PREF path attribute.
-
-
- log_updown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable log a message for peer state transitions.
-
-
- metric_out - -
- dictionary -
- 		- -
Specify route metric sent in MED.
-
-
- igp - -
- dictionary -
- 		- -
Track the IGP metric.
-
-
- delay_med_update - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delay updating MED when IGP metric increases.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the IGP metric.
-
-
- metric_value - -
- integer -
- 		- -
Specify metric value.
-
-
- minimum_igp - -
- dictionary -
- 		- -
Track the minimum IGP metric.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the minimum IGP metric.
-
-
- mtu_discovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable TCP path MTU discovery.
-
-
- multihop - -
- dictionary -
- 		- -
Configure an EBGP multihop session.
-
-
- no_nexthop_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not change next hop to self in advertisements.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set an EBGP multihop session.
-
-
- ttl - -
- integer -
- 		- -
TTL value for the session.
-
-
- multipath - -
- dictionary -
- 		- -
Allow load sharing among multiple BGP paths.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable Multipath.
-
-
- multiple_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use paths received from different ASs.
-
-
- multiple_as_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable multipath.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set allow load sharing among multiple BGP paths.
-
-
- neighbor_address - -
- string -
- 		- -
Specify neighbor address.
-
-
- no_advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allows to not advertise routes received from the same autonomous system.
-
-
- no_aggregator_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router ID in aggregator path attribute to 0.
-
-
- no_client_reflect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable intracluster route redistribution.
-
-
- out_delay - -
- integer -
- 		- -
Specify how long before exporting routes from routing table.
-
-
- outbound_route_filter - -
- dictionary -
- 		- -
Dynamically negotiated cooperative route filtering.
-
-
- bgp_orf_cisco_mode - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Using BGP ORF capability code 130 and Prefix ORF type 128.
-
-
- prefix_based - -
- dictionary -
- 		- -
Prefix-based outbound route filtering.
-
-
- accept - -
- dictionary -
- 		- -
Honor Prefix-based ORFs from remote peers.
-
-
- inet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv4 prefix filters.
-
-
- inet6 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv6 prefix filters.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set honor Prefix-based ORFs from remote peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set prefix-based outbound route filtering.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify to not send open messages to a peer.
-
-
- peer_as - -
- string -
- 		- -
Specify Autonomous system number in plain number or 'higher 16bits'.'Lower 16 bits' format.
-
-
- preference - -
- string -
- 		- -
Specify preference value.
-
-
- remove_private - -
- dictionary -
- 		- -
Remove well-known private AS numbers.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove all private AS numbers and do not stop at the first public AS number.
-
-
- all_replace - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify private AS replacement.
-
-
- all_replace_nearest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use closest public AS number to replace a private AS number.
-
-
- no_peer_loop_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove peer loop-check.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove well-known private AS numbers.
-
-
- rfc6514_compliant_safi129 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Compliance with RFC6514 SAFI129 format.
-
-
- route_server_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route server client behavior.
-
-
- tcp_aggressive_transmission - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable aggressive transmission of pure TCP ACKs and retransmissions.
-
-
- tcp_mss - -
- integer -
- 		- -
Specify maximum TCP segment size.
-
-
- traceoptions - -
- dictionary -
- 		- -
Configure trace options for BGP.
-
-
- file - -
- dictionary -
- 		- -
Specify trace file options.
-
-
- filename - -
- string - / required -
- 		- -
Specify name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Specify maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Specify maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- flag - -
- list - / elements=dictionary -
- 		- -
Specify tracing parameters.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace detailed information.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable this trace flag.
-
-
- filter - -
- dictionary -
- 		- -
Filter to apply to this flag.
-
-
- match_on_prefix - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify filter based on prefix.
-
-
- policy - -
- string -
- 		- -
Specify filter policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set filter to apply to this flag.
-
-
- name - -
- string - / required -
- 		-
    Choices: -
  • 4byte-as
    • -
  • add-path
    • -
  • all
    • -
  • bfd
    • -
  • damping
    • -
  • egress-te
    • -
  • general
    • -
  • graceful-restart
    • -
  • keepalive
    • -
  • normal
    • -
  • nsr-synchronization
    • -
  • open
    • -
  • packets
    • -
  • policy
    • -
  • refresh
    • -
  • route
    • -
  • state
    • -
  • task
    • -
  • thread-io
    • -
  • thread-update-io
    • -
  • timer
    • -
  • update
    • -
- 		-
specify event name
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace received packets.
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace transmitted packets.
-
-
- ttl - -
- integer -
- 		- -
Specify TTL value for the single-hop peer.
-
-
- unconfigured_peer_graceful_restart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify BGP unconfigured peer graceful restart options.
-
-
- vpn_apply_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Apply BGP export policy when exporting VPN routes.
-
-
- no_advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allows to not advertise routes received from the same autonomous system.
-
-
- no_aggregator_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router ID in aggregator path attribute to 0.
-
-
- no_client_reflect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable intracluster route redistribution.
-
-
- optimal_route_reflection - -
- dictionary -
- 		- -
Enable optimal route reflection for this client group.
-
-
- igp_backup - -
- string -
- 		- -
Backup node identifier for this client group.
-
-
- igp_primary - -
- string -
- 		- -
Primary node identifier for this client group.
-
-
- out_delay - -
- integer -
- 		- -
Specify how long before exporting routes from routing table.
-
-
- outbound_route_filter - -
- dictionary -
- 		- -
Dynamically negotiated cooperative route filtering.
-
-
- bgp_orf_cisco_mode - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Using BGP ORF capability code 130 and Prefix ORF type 128.
-
-
- prefix_based - -
- dictionary -
- 		- -
Prefix-based outbound route filtering.
-
-
- accept - -
- dictionary -
- 		- -
Honor Prefix-based ORFs from remote peers.
-
-
- inet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv4 prefix filters.
-
-
- inet6 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv6 prefix filters.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set honor Prefix-based ORFs from remote peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set prefix-based outbound route filtering.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify to not send open messages to a peer.
-
-
- peer_as - -
- string -
- 		- -
Specify Autonomous system number in plain number or 'higher 16bits'.'Lower 16 bits' format.
-
-
- preference - -
- string -
- 		- -
Specify preference value.
-
-
- remove_private - -
- dictionary -
- 		- -
Remove well-known private AS numbers.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove all private AS numbers and do not stop at the first public AS number.
-
-
- all_replace - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify private AS replacement.
-
-
- all_replace_nearest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use closest public AS number to replace a private AS number.
-
-
- no_peer_loop_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove peer loop-check.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove well-known private AS numbers.
-
-
- rfc6514_compliant_safi129 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Compliance with RFC6514 SAFI129 format.
-
-
- route_server_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route server client behavior.
-
-
- tcp_aggressive_transmission - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable aggressive transmission of pure TCP ACKs and retransmissions.
-
-
- tcp_mss - -
- integer -
- 		- -
Specify maximum TCP segment size.
-
-
- traceoptions - -
- dictionary -
- 		- -
Configure trace options for BGP.
-
-
- file - -
- dictionary -
- 		- -
Specify trace file options.
-
-
- filename - -
- string - / required -
- 		- -
Specify name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Specify maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Specify maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- flag - -
- list - / elements=dictionary -
- 		- -
Specify tracing parameters.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace detailed information.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable this trace flag.
-
-
- filter - -
- dictionary -
- 		- -
Filter to apply to this flag.
-
-
- match_on_prefix - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify filter based on prefix.
-
-
- policy - -
- string -
- 		- -
Specify filter policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set filter to apply to this flag.
-
-
- name - -
- string - / required -
- 		-
    Choices: -
  • 4byte-as
    • -
  • add-path
    • -
  • all
    • -
  • bfd
    • -
  • damping
    • -
  • egress-te
    • -
  • general
    • -
  • graceful-restart
    • -
  • keepalive
    • -
  • normal
    • -
  • nsr-synchronization
    • -
  • open
    • -
  • packets
    • -
  • policy
    • -
  • refresh
    • -
  • route
    • -
  • state
    • -
  • task
    • -
  • thread-io
    • -
  • thread-update-io
    • -
  • timer
    • -
  • update
    • -
- 		-
specify event name
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace received packets.
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace transmitted packets.
-
-
- ttl - -
- integer -
- 		- -
Specify TTL value for the single-hop peer.
-
-
- type - -
- string -
- 		-
    Choices: -
  • external
    • -
  • internal
    • -
- 		-
Specify BGP group type.
-
-
- unconfigured_peer_graceful_restart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify BGP unconfigured peer graceful restart options.
-
-
- vpn_apply_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Apply BGP export policy when exporting VPN routes.
-
-
- hold_time - -
- integer -
- 		- -
Specify hold time used when negotiating with a peer.
-
-
- holddown_all_stale_labels - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hold all BGP stale-labels, facilating make-before-break for new label advertisements.
-
-
- idle_after_switch_over - -
- dictionary -
- 		- -
Stop peer session from coming up after nonstop-routing switch-over.
-
-
- forever - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Idle the peer until the user intervenes.
-
-
- timeout - -
- integer -
- 		- -
Specify timeout value, in seconds, for starting peer after switch over.
-
-
- import - -
- list - / elements=string -
- 		- -
Specify import policy.
-
-
- include_mp_next_hop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include NEXT-HOP attribute in multiprotocol updates.
-
-
- ipsec_sa - -
- string -
- 		- -
Specify IPSec SA name.
-
-
- keep - -
- string -
- 		-
    Choices: -
  • all
    • -
  • none
    • -
- 		-
Specify how to retain routes in the routing table.
-
-
- local_address - -
- string -
- 		- -
Specify Address of local end of BGP session.
-
-
- local_as - -
- dictionary -
- 		- -
Local autonomous system number.
-
-
- alias - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat this AS as an alias to the system AS.
-
-
- as_num - -
- string - / required -
- 		- -
Autonomous system number in plain number or (asdot notation) format.
-
-
- loops - -
- integer -
- 		- -
Maximum number of times this AS can be in an AS path.
-
-
- no_prepend_global_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maximum number of times this AS can be in an AS path.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hide this local AS in paths learned from this peering.
-
-
- local_interface - -
- string -
- 		- -
Specify Local interface for IPv6 link local EBGP peering.
-
-
- local_preference - -
- string -
- 		- -
Specify value of LOCAL_PREF path attribute.
-
-
- log_updown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable log a message for peer state transitions.
-
-
- loops - -
- integer -
- 		- -
Specify maximum number of times this AS can be in an AS path.
-
-
- metric_out - -
- dictionary -
- 		- -
Specify route metric sent in MED.
-
-
- igp - -
- dictionary -
- 		- -
Track the IGP metric.
-
-
- delay_med_update - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delay updating MED when IGP metric increases.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the IGP metric.
-
-
- metric_value - -
- integer -
- 		- -
Specify metric value.
-
-
- minimum_igp - -
- dictionary -
- 		- -
Track the minimum IGP metric.
-
-
- metric_offset - -
- integer -
- 		- -
Specify metric offset for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set track the minimum IGP metric.
-
-
- mtu_discovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable TCP path MTU discovery.
-
-
- multihop - -
- dictionary -
- 		- -
Configure an EBGP multihop session.
-
-
- no_nexthop_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not change next hop to self in advertisements.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set an EBGP multihop session.
-
-
- ttl - -
- integer -
- 		- -
TTL value for the session.
-
-
- multipath - -
- dictionary -
- 		- -
Allow load sharing among multiple BGP paths.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable Multipath.
-
-
- multiple_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use paths received from different ASs.
-
-
- multiple_as_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable multipath.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set allow load sharing among multiple BGP paths.
-
-
- multipath_build_priority - -
- string -
- 		-
    Choices: -
  • low
    • -
  • medium
    • -
- 		-
Configure the multipath build priority.
-
-
- no_advertise_peer_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allows to not advertise routes received from the same autonomous system.
-
-
- no_aggregator_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router ID in aggregator path attribute to 0.
-
-
- no_client_reflect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable intracluster route redistribution.
-
-
- no_precision_timers - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify not to use precision timers for scheduling keepalives.
-
-
- out_delay - -
- integer -
- 		- -
Specify how long before exporting routes from routing table.
-
-
- outbound_route_filter - -
- dictionary -
- 		- -
Dynamically negotiated cooperative route filtering.
-
-
- bgp_orf_cisco_mode - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Using BGP ORF capability code 130 and Prefix ORF type 128.
-
-
- prefix_based - -
- dictionary -
- 		- -
Prefix-based outbound route filtering.
-
-
- accept - -
- dictionary -
- 		- -
Honor Prefix-based ORFs from remote peers.
-
-
- inet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv4 prefix filters.
-
-
- inet6 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Honor IPv6 prefix filters.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set honor Prefix-based ORFs from remote peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set prefix-based outbound route filtering.
-
-
- output_queue_priority - -
- dictionary -
- 		- -
BGP output queue priority scheduler for updates.
-
-
- defaults - -
- dictionary -
- 		- -
Map policy's priority class and BGP output-queue.
-
-
- high - -
- dictionary -
- 		- -
Assign the 'high' priority class to this output-queue.
-
-
- expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- priority - -
- integer -
- 		- -
Specify output queue priorit.
-
-
- low - -
- dictionary -
- 		- -
Assign the 'low' priority class to this output-queue.
-
-
- expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- priority - -
- integer -
- 		- -
Specify output queue priorit.
-
-
- medium - -
- dictionary -
- 		- -
Assign the 'medium' priority class to this output-queue.
-
-
- expedited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Expedited queue; highest priority.
-
-
- priority - -
- integer -
- 		- -
Specify output queue priorit.
-
-
- expedited_update_tokens - -
- integer -
- 		- -
Expedited queue; highest priority for number of tokens.
-
-
- priority_update_tokens - -
- list - / elements=dictionary -
- 		- -
Output queue priority; higher is better.
-
-
- priority - -
- integer - / required -
- 		- -
Specify the priority.
-
-
- update_tokens - -
- integer - / required -
- 		- -
Specify update_tokens.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify to not send open messages to a peer.
-
-
- path_selection - -
- dictionary -
- 		- -
Configure path selection strategy.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS path comparison during path selection.
-
-
- cisco_non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use Cisco IOS nondeterministic path selection algorithm.
-
-
- external_router_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router ID on BGP externals.
-
-
- l2vpn_use_bgp_rules - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use standard BGP rules during L2VPN path selection.
-
-
- med_plus_igp - -
- dictionary -
- 		- -
Add IGP cost to next-hop to MED before comparing MED values.
-
-
- igp_multiplier - -
- integer -
- 		- -
Specify multiplier for IGP cost to next-hop.
-
-
- med_multiplier - -
- integer -
- 		- -
Specify Multiplier for MED.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set med-plus-igp attribute.
-
-
- peer_as - -
- string -
- 		- -
Specify Autonomous system number in plain number or 'higher 16bits'.'Lower 16 bits' format.
-
-
- precision_timers - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use precision timers for scheduling keepalives.
-
-
- preference - -
- string -
- 		- -
Specify preference value.
-
-
- remove_private - -
- dictionary -
- 		- -
Remove well-known private AS numbers.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove all private AS numbers and do not stop at the first public AS number.
-
-
- all_replace - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify private AS replacement.
-
-
- all_replace_nearest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use closest public AS number to replace a private AS number.
-
-
- no_peer_loop_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove peer loop-check.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove well-known private AS numbers.
-
-
- rfc6514_compliant_safi129 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Compliance with RFC6514 SAFI129 format.
-
-
- route_server_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable route server client behavior.
-
-
- send_addpath_optimization - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BGP addpath advertisement optimization.
-
-
- snmp_options - -
- dictionary -
- 		- -
Customize SNMP behaviors specifically for BGP MIBs.
-
-
- backward_traps_only_from_established - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Limit traps for backward transitions to only those moving from Established state.
-
-
- emit_inet_address_length_in_oid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Emit Length in OID for InetAddress MIB type.
-
-
- sr_preference_override - -
- string -
- 		- -
Replace received segment routing traffic engineering preference value with override value.
-
-
- stale_labels_holddown_period - -
- integer -
- 		- -
Specify duration (sec) MPLS labels allocated by BGP are kept after they go stale.
-
-
- tcp_aggressive_transmission - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable aggressive transmission of pure TCP ACKs and retransmissions.
-
-
- tcp_mss - -
- integer -
- 		- -
Specify maximum TCP segment size.
-
-
- traceoptions - -
- dictionary -
- 		- -
Configure trace options for BGP.
-
-
- file - -
- dictionary -
- 		- -
Specify trace file options.
-
-
- filename - -
- string - / required -
- 		- -
Specify name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Specify maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Specify maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- flag - -
- list - / elements=dictionary -
- 		- -
Specify tracing parameters.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace detailed information.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable this trace flag.
-
-
- filter - -
- dictionary -
- 		- -
Filter to apply to this flag.
-
-
- match_on_prefix - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify filter based on prefix.
-
-
- policy - -
- string -
- 		- -
Specify filter policy.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set filter to apply to this flag.
-
-
- name - -
- string - / required -
- 		-
    Choices: -
  • 4byte-as
    • -
  • add-path
    • -
  • all
    • -
  • bfd
    • -
  • damping
    • -
  • egress-te
    • -
  • general
    • -
  • graceful-restart
    • -
  • keepalive
    • -
  • normal
    • -
  • nsr-synchronization
    • -
  • open
    • -
  • packets
    • -
  • policy
    • -
  • refresh
    • -
  • route
    • -
  • state
    • -
  • task
    • -
  • thread-io
    • -
  • thread-update-io
    • -
  • timer
    • -
  • update
    • -
- 		-
specify event name
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace received packets.
-
-
- send - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace transmitted packets.
-
-
- traffic_statistics_labeled_path - -
- dictionary -
- 		- -
Collect periodic ingress labeled statistics for BGP label-switched paths.
-
-
- file - -
- dictionary -
- 		- -
Specify statistics file options.
-
-
- filename - -
- string -
- 		- -
Specify name of file in which to write trace information.
-
-
- files - -
- integer -
- 		- -
Specify maximum number of trace files.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Specify maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- interval - -
- integer -
- 		- -
Specify time interval to collect statistics.
-
-
- ttl - -
- integer -
- 		- -
Specify TTL value for the single-hop peer.
-
-
- unconfigured_peer_graceful_restart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify BGP unconfigured peer graceful restart options.
-
-
- vpn_apply_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Apply BGP export policy when exporting VPN routes.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show protocols bgp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • purged
    • -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all (routing-options autonomous-system, bgp global, bgp groups, bgp neighbors, bgp family and bgp group and neighbor family) the BGP configurations from the target device. Use caution with this state.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor.Please use the junipernetworks.junos.junos_bgp_address_family modules for prior cleanup.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state: - # ------------- - # - # vsrx# show bgp summary - # BGP is not running - - # vsrx# show routing-options autonomous-system - - - name: Merge provided bgp config with device configuration - junipernetworks.junos.junos_bgp_global: - config: - as_number: "65534" - loops: 3 - asdot_notation: true - accept_remote_nexthop: true - add_path_display_ipv4_address: true - advertise_from_main_vpn_tables: true - advertise_inactive: true - authentication_algorithm: "md5" - bgp_error_tolerance: - malformed_route_limit: 20000000 - bmp: - monitor: true - damping: true - description: "This is configured with Junos_bgp resource module" - egress_te_sid_stats: true - hold_time: 5 - holddown_all_stale_labels: true - include_mp_next_hop: true - log_updown: true - no_advertise_peer_as: true - no_aggregator_id: true - no_client_reflect: true - out_delay: 10 - precision_timers: true - preference: 2 - state: merged - - # Task Output: - # ------------ - # before: {} - # - # commands: - # - - # - # - - # 655343 - # - # after: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65534' - # asdot_notation: true - # authentication_algorithm: md5 - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # loops: 3 - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - - # After state: - # ------------ - # - # vsrx# show routing-options autonomous-system - # 65534 loops 3 asdot-notation; - - # vsrx# show protocols bgp - # precision-timers; - # advertise-from-main-vpn-tables; - # holddown-all-stale-labels; - # description "This is configured with Junos_bgp resource module"; - # accept-remote-nexthop; - # preference 2; - # hold-time 5; - # advertise-inactive; - # no-advertise-peer-as; - # no-aggregator-id; - # out-delay 10; - # log-updown; - # damping; - # bgp-error-tolerance { - # malformed-route-limit 20000000; - # } - # authentication-algorithm md5; - # no-client-reflect; - # include-mp-next-hop; - # bmp { - # monitor enable; - # } - # add-path-display-ipv4-address; - # egress-te-sid-stats; - - # Using replaced - # - # Before state: - # ------------- - # - # vsrx# show routing-options autonomous-system - # [edit] - # vsrx# show protocols bgp - # precision-timers; - # advertise-from-main-vpn-tables; - # holddown-all-stale-labels; - # description "This is configured with Junos_bgp resource module"; - # accept-remote-nexthop; - # preference 2; - # hold-time 5; - # advertise-inactive; - # no-advertise-peer-as; - # no-aggregator-id; - # out-delay 10; - # log-updown; - # damping; - # bgp-error-tolerance { - # malformed-route-limit 20000000; - # } - # authentication-algorithm md5; - # no-client-reflect; - # include-mp-next-hop; - # bmp { - # monitor enable; - # } - # add-path-display-ipv4-address; - # egress-te-sid-stats; - - - name: Replace running config with provided config - junipernetworks.junos.junos_bgp_global: - config: - advertise_inactive: true - authentication_algorithm: "md5" - bfd_liveness_detection: - minimum_receive_interval: 8 - multiplier: 30 - no_adaptation: true - transmit_interval: - minimum_interval: 4 - version: "automatic" - bgp_error_tolerance: - malformed_route_limit: 40000000 - description: "Replace running bgp config" - egress_te_sid_stats: true - hold_time: 5 - out_delay: 10 - preference: "2" - state: replaced - - # Task Output: - # ------------ - # - # before: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65534' - # asdot_notation: true - # authentication_algorithm: md5 - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # loops: 3 - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - - # commands: - # - - # - # - # md5Replace running bgp conf> - # - - - # - # after: - # advertise_inactive: true - # authentication_algorithm: md5 - # bfd_liveness_detection: - # minimum_receive_interval: 8 - # multiplier: 30 - # no_adaptation: true - # transmit_interval: - # minimum_interval: 4 - # version: automatic - # bgp_error_tolerance: - # malformed_route_limit: 40000000 - # description: Replace running bgp config - # egress_te_sid_stats: true - # hold_time: 5 - # out_delay: 10 - # preference: '2' - - # After state: - # ------------ - # - # varx# show protocols bgp - # description "Replace running bgp config"; - # preference 2; - # hold-time 5; - # advertise-inactive; - # out-delay 10; - # bgp-error-tolerance { - # malformed-route-limit 40000000; - # } - # authentication-algorithm md5; - # bfd-liveness-detection { - # version automatic; - # minimum-receive-interval 8; - # multiplier 30; - # no-adaptation; - # transmit-interval { - # minimum-interval 4; - # } - # } - # egress-te-sid-stats; - - # vsrx# show routing-options autonomous-system - - # Using overridden - # "(NOTE: This will work same as replaced operation)" - # - # Before state: - # ------------- - # - # vsrx# show routing-options autonomous-system - # [edit] - # vsrx# show protocols bgp - # precision-timers; - # advertise-from-main-vpn-tables; - # holddown-all-stale-labels; - # description "This is configured with Junos_bgp resource module"; - # accept-remote-nexthop; - # preference 2; - # hold-time 5; - # advertise-inactive; - # no-advertise-peer-as; - # no-aggregator-id; - # out-delay 10; - # log-updown; - # damping; - # bgp-error-tolerance { - # malformed-route-limit 20000000; - # } - # authentication-algorithm md5; - # no-client-reflect; - # include-mp-next-hop; - # bmp { - # monitor enable; - # } - # add-path-display-ipv4-address; - # egress-te-sid-stats; - - - name: Override running config with provided config - junipernetworks.junos.junos_bgp_global: - config: - advertise_inactive: true - authentication_algorithm: "md5" - bfd_liveness_detection: - minimum_receive_interval: 8 - multiplier: 30 - no_adaptation: true - transmit_interval: - minimum_interval: 4 - version: "automatic" - bgp_error_tolerance: - malformed_route_limit: 40000000 - description: "Replace running bgp config" - egress_te_sid_stats: true - hold_time: 5 - out_delay: 10 - preference: "2" - state: overridden - - # Task Output: - # ------------ - # - # before: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65534' - # asdot_notation: true - # authentication_algorithm: md5 - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # loops: 3 - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - - # commands: - # - - # - # - # md5Replace running bgp conf> - # - - - # - # after: - # advertise_inactive: true - # authentication_algorithm: md5 - # bfd_liveness_detection: - # minimum_receive_interval: 8 - # multiplier: 30 - # no_adaptation: true - # transmit_interval: - # minimum_interval: 4 - # version: automatic - # bgp_error_tolerance: - # malformed_route_limit: 40000000 - # description: Replace running bgp config - # egress_te_sid_stats: true - # hold_time: 5 - # out_delay: 10 - # preference: '2' - - # After state: - # ------------ - # - # varx# show protocols bgp - # description "Replace running bgp config"; - # preference 2; - # hold-time 5; - # advertise-inactive; - # out-delay 10; - # bgp-error-tolerance { - # malformed-route-limit 40000000; - # } - # authentication-algorithm md5; - # bfd-liveness-detection { - # version automatic; - # minimum-receive-interval 8; - # multiplier 30; - # no-adaptation; - # transmit-interval { - # minimum-interval 4; - # } - # } - # egress-te-sid-stats; - - # vsrx# show routing-options autonomous-system - - # Using deleted - # "(NOTE: This WILL delete the bgp global attributes)" - # Before state - # ------------ - # - # vsrx# show protocols bgp - # description "Replace running bgp config"; - # preference 2; - # hold-time 5; - # advertise-inactive; - # out-delay 10; - # bgp-error-tolerance { - # malformed-route-limit 40000000; - # } - # authentication-algorithm md5; - # bfd-liveness-detection { - # version automatic; - # minimum-receive-interval 8; - # multiplier 30; - # no-adaptation; - # transmit-interval { - # minimum-interval 4; - # } - # } - # egress-te-sid-stats; - - - name: Delete bgp section of running config - junipernetworks.junos.junos_bgp_global: - config: - state: deleted - - # Task Output: - # ------------ - - # before: - # advertise_inactive: true - # authentication_algorithm: md5 - # bfd_liveness_detection: - # minimum_receive_interval: 8 - # multiplier: 30 - # no_adaptation: true - # transmit_interval: - # minimum_interval: 4 - # version: automatic - # bgp_error_tolerance: - # malformed_route_limit: 40000000 - # description: Replace running bgp config - # egress_te_sid_stats: true - # hold_time: 5 - # out_delay: 10 - # preference: '2' - - # commands: - # - - # - # - # - - - # after: {} - - # After state: - # ------------ - # vsrx# show protocols bgp - - # vsrx# show routing-options autonomous-system - - # Using gathered - # - # Before state: - # ------------- - # - # vsrx# show protocols bgp - # precision-timers; - # advertise-from-main-vpn-tables; - # holddown-all-stale-labels; - # description "This is configured with Junos_bgp resource module"; - # accept-remote-nexthop; - # preference 2; - # hold-time 5; - # advertise-inactive; - # no-advertise-peer-as; - # no-aggregator-id; - # out-delay 10; - # log-updown; - # damping; - # bgp-error-tolerance { - # malformed-route-limit 20000000; - # } - # authentication-algorithm md5; - # no-client-reflect; - # include-mp-next-hop; - # bmp { - # monitor enable; - # } - # add-path-display-ipv4-address; - # egress-te-sid-stats; - - - name: Gather BGP facts from running config - junipernetworks.junos.junos_bgp_global: - config: - state: gathered - - # Task Output: - # ------------ - - # gathered: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65534' - # asdot_notation: true - # authentication_algorithm: md5 - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # loops: 3 - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - - # Using purged - # "(NOTE: This WILL delete the configured global BGP, and BGP address family config)" - - # Before state: - # ------------- - # - # vsrx# show protocols bgp - # precision-timers; - # advertise-from-main-vpn-tables; - # holddown-all-stale-labels; - # description "This is configured with Junos_bgp resource module"; - # accept-remote-nexthop; - # preference 2; - # hold-time 5; - # advertise-inactive; - # no-advertise-peer-as; - # no-aggregator-id; - # out-delay 10; - # log-updown; - # damping; - # bgp-error-tolerance { - # malformed-route-limit 20000000; - # } - # authentication-algorithm md5; - # no-client-reflect; - # include-mp-next-hop; - # bmp { - # monitor enable; - # } - # add-path-display-ipv4-address; - # egress-te-sid-stats; - - - name: Purge BGP config from running config - junipernetworks.junos.junos_bgp_global: - config: - state: purged - - # Task Output: - # ------------ - - # before: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65534' - # asdot_notation: true - # authentication_algorithm: md5 - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # loops: 3 - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - - # commands: - # - - # - - # - - # after: {} - - # After state: - # ------------ - # vsrx# show protocols bgp - - # vsrx# show routing-options autonomous-system - - # Using rendered - - - name: Render the commands for provided configuration - junipernetworks.junos.junos_bgp_global: - config: - as_number: "65534" - loops: 3 - asdot_notation: true - accept_remote_nexthop: true - add_path_display_ipv4_address: true - advertise_from_main_vpn_tables: true - advertise_inactive: true - authentication_algorithm: "md5" - bgp_error_tolerance: - malformed_route_limit: 20000000 - bmp: - monitor: true - damping: true - description: "This is configured with Junos_bgp resource module" - egress_te_sid_stats: true - hold_time: 5 - holddown_all_stale_labels: true - include_mp_next_hop: true - log_updown: true - no_advertise_peer_as: true - no_aggregator_id: true - no_client_reflect: true - out_delay: 10 - precision_timers: true - preference: 2 - state: rendered - - # Task Output: - # ------------ - - # rendered: - # - # - # - - # - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # - # - # - # This is configured with Junos_bgp resource module - # - # 2 - # 5 - # - # - # - # 10 - # - # - # - # 20000000 - # - # md5 - # - # - # - # - # disable - # - # - # - # - # - # static-to-bgp - # - # - # - # automatic - # 4 - # 10 - # - # - # 2 - # - # - # 300000 - # - # - # - # - # internal - # 8 - # - # - # external - # 9 - # - # - # inboun - # internal - # - # - # ibgp - # internal - # 10.2.2.2 - # static-to-bgp - # - # 10.1.1.1 - # - # - # - # - # - # 0.0.0.100 - # - # 200 - # - # - # so-0/0/0.0 - # 5 - # 3 - # - # - # - # - # - # - # - # 172.16.17.0/24 - # - # - # - # 10.200.16.75 - # - # 65432 - # - # - # - # - - - - name: Parsed the device configuration to get ansible facts - junipernetworks.junos.junos_bgp_global: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task Output: - # ------------ - - # parsed: - # accept_remote_nexthop: true - # add_path_display_ipv4_address: true - # advertise_bgp_static: - # policy: static-to-bgp - # advertise_from_main_vpn_tables: true - # advertise_inactive: true - # as_number: '65432' - # authentication_algorithm: md5 - # bfd_liveness_detection: - # detection_time: - # threshold: 300000 - # minimum_receive_interval: 4 - # multiplier: 10 - # no_adaptation: true - # transmit_interval: - # minimum_interval: 2 - # version: automatic - # bgp_error_tolerance: - # malformed_route_limit: 20000000 - # bmp: - # monitor: false - # route_monitoring: - # none: true - # damping: true - # description: This is configured with Junos_bgp resource module - # egress_te_sid_stats: true - # groups: - # - name: internal - # out_delay: 8 - # - name: external - # out_delay: 9 - # - name: inboun - # type: internal - # - export: static-to-bgp - # local_address: 10.2.2.2 - # name: ibgp - # neighbors: - # - neighbor_address: 10.1.1.1 - # type: internal - # hold_time: 5 - # holddown_all_stale_labels: true - # include_mp_next_hop: true - # log_updown: true - # no_advertise_peer_as: true - # no_aggregator_id: true - # no_client_reflect: true - # out_delay: 10 - # precision_timers: true - # preference: '2' - # remove_private: - # set: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
[' <nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:bgp> <nc:damping/> <nc:egress-te-sid-stats/> <nc:authentication-algorithm>md5</nc:authentication-algorithm> <nc:description>This is configured with Junos_bgp resource module</nc:description> <nc:hold-time>5</nc:hold-time> <nc:bfd-liveness-detection> <nc:transmit-interval> <nc:minimum-interval>2</nc:minimum-interval> </nc:transmit-interval> <nc:minimum-receive-interval>4</nc:minimum-receive-interval> <nc:multiplier>10</nc:multiplier> <nc:no-adaptation/> <nc:version>automatic</nc:version> </nc:bfd-liveness-detection> <nc:bgp-error-tolerance> <nc:malformed-route-limit>20000000</nc:malformed-route-limit> </nc:bgp-error-tolerance> <nc:bmp> <nc:monitor>enable</nc:monitor> </nc:bmp> </nc:bgp> </nc:protocols>', 'xml 2', 'xml 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_facts_module.rst b/docs/junipernetworks.junos.junos_facts_module.rst deleted file mode 100644 index 13509652..00000000 --- a/docs/junipernetworks.junos.junos_facts_module.rst +++ /dev/null @@ -1,162 +0,0 @@ -.. _junipernetworks.junos.junos_facts_module: - - -********************************* -junipernetworks.junos.junos_facts -********************************* - -**Collect facts from remote devices running Juniper Junos** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Collects fact information from a remote device running the Junos operating system. By default, the module will collect basic fact information from the device to be included with the hostvars. Additional fact information can be collected based on the configured set of arguments. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.5.2) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- available_network_resources - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When 'True' a list of network resources for which resource modules are available will be provided.
-
-
- config_format - -
- string -
- 		-
    Choices: -
  • xml
    • -
  • text ←
    • -
  • set
    • -
  • json
    • -
- 		-
The config_format argument specifies the format of the configuration when serializing output from the device. This argument is applicable only when config value is present in gather_subset. The config_format should be supported by the junos version running on device. This value is not applicable while fetching old style facts that is when ofacts value is present in value if gather_subset value. This option is valid only for gather_subset values.
-
-
- gather_network_resources - -
- list - / elements=string -
- 		- -
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, vlans etc. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'lacp', 'lacp_interfaces', 'lag_interfaces', 'l2_interfaces', 'l3_interfaces', 'lldp_global', 'lldp_interfaces', 'vlans'.
-
-
- gather_subset - -
- list - / elements=string -
- 		- Default:
["min"]
- 		-
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, interfaces and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. To maintain backward compatibility old style facts can be retrieved by explicitly adding ofacts to value, this requires junos-eznc to be installed as a prerequisite. Valid value of gather_subset are default, hardware, config, interfaces, ofacts. If ofacts is present in the list it fetches the old style facts (fact keys without 'ansible_' prefix) and it requires junos-eznc library to be installed.
-
-
- - -Notes ------ - -.. note:: - - Ensure *config_format* used to retrieve configuration from device is supported by junos version running on device. - - With *config_format = json*, configuration in the results will be a dictionary(and not a JSON string) - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. - - Recommended connection is ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - This module also works with ``local`` connections for legacy playbooks. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - - name: collect default set of facts - junipernetworks.junos.junos_facts: - - - name: collect default set of facts and configuration - junipernetworks.junos.junos_facts: - gather_subset: config - - - name: Gather legacy and resource facts - junipernetworks.junos.junos_facts: - gather_subset: all - gather_network_resources: all - - - - -Status ------- - - -Authors -~~~~~~~ - -- Nathaniel Case (@Qalthos) diff --git a/docs/junipernetworks.junos.junos_interfaces_module.rst b/docs/junipernetworks.junos.junos_interfaces_module.rst deleted file mode 100644 index 0a5d41ae..00000000 --- a/docs/junipernetworks.junos.junos_interfaces_module.rst +++ /dev/null @@ -1,1175 +0,0 @@ -.. _junipernetworks.junos.junos_interfaces_module: - - -************************************** -junipernetworks.junos.junos_interfaces -************************************** - -**Junos Interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages the interfaces on Juniper Junos OS network devices. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- description - -
- string -
- 		- -
Interface description.
-
-
- duplex - -
- string -
- 		-
    Choices: -
  • automatic
    • -
  • full-duplex
    • -
  • half-duplex
    • -
- 		-
Interface link status. Applicable for Ethernet interfaces only, either in half duplex, full duplex or in automatic state which negotiates the duplex automatically.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Administrative state of the interface.
-
Set the value to true to administratively enabled the interface or false to disable it.
-
-
- hold_time - -
- dictionary -
- 		- -
The hold time for given interface name.
-
-
- down - -
- integer -
- 		- -
The link down hold time in milliseconds.
-
-
- up - -
- integer -
- 		- -
The link up hold time in milliseconds.
-
-
- mtu - -
- integer -
- 		- -
MTU for a specific interface.
-
Applicable for Ethernet interfaces only.
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, e.g. ge-0/0/0.
-
-
- speed - -
- string -
- 		- -
Interface link speed. Applicable for Ethernet interfaces only.
-
-
- units - -
- list - / elements=dictionary -
- 		- -
Specify Logical interfaces units.
-
-
- description - -
- string -
- 		- -
Specify logical interface description.
-
-
- name - -
- integer -
- 		- -
Specify interface unit number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show interfaces.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 18.4R1. - - This module works with connection ``netconf``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_junos.html - - The module examples uses callback plugin (stdout_callback = yaml) to generate task output in yaml format. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # user@junos01# show interfaces - # ge-0/0/1 { - # description "test interface"; - # speed 1g; - # } - # fe-0/0/2 { - # vlan-tagging; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - name: Merge provided configuration with device configuration (default operation - is merge) - junipernetworks.junos.junos_interfaces: - config: - - name: ge-0/0/1 - description: Configured by Ansible-1 - enabled: true - units: - - name: 0 - description: "This is logical intf unit0" - mtu: 1800 - - name: ge-0/0/2 - description: Configured by Ansible-2 - enabled: false - state: merged - - # Task Output - # ----------- - # - # before: - # - description: test interface - # enabled: true - # name: ge-0/0/1 - # speed: 1g - # - enabled: true - # name: fe-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - # commands: - # - ge-0/0/1 - # Configured by Ansible-118000 - # This is logical intf unit0ge-0/0/2 - # Configured by Ansible-2 - # after: - # - description: Configured by Ansible-1 - # enabled: true - # mtu: 1800 - # name: ge-0/0/1 - # speed: 1g - # units: - # - description: This is logical intf unit0 - # name: 0 - # - enabled: true - # name: fe-0/0/2 - # - description: Configured by Ansible-2 - # enabled: false - # name: ge-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Configured by Ansible-1"; - # speed 1g; - # mtu 1800; - # unit 0 { - # description "This is logical intf unit0"; - # } - # } - # fe-0/0/2 { - # vlan-tagging; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - # Using deleted - - # Before state: - # ------------- - # - # ge-0/0/1 { - # description "Configured by Ansible-1"; - # speed 1g; - # mtu 1800; - # unit 0 { - # description "This is logical intf unit0"; - # } - # } - # fe-0/0/2 { - # vlan-tagging; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - name: "Delete given options for the interface (Note: This won't delete the interface itself if any other values are configured for interface)" - junipernetworks.junos.junos_interfaces: - config: - - name: ge-0/0/1 - description: Configured by Ansible-1 - speed: 1g - mtu: 1800 - - name: ge-0/0/2 - description: Configured by Ansible -2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - description: Configured by Ansible-1 - # enabled: true - # mtu: 1800 - # name: ge-0/0/1 - # speed: 1g - # units: - # - description: This is logical intf unit0 - # name: 0 - # - enabled: true - # name: fe-0/0/2 - # - description: Configured by Ansible-2 - # enabled: false - # name: ge-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - # commands: - # - - # ge-0/0/1 - # - # - # 0ge-0/0/2 - # - # - # - # after: - # - enabled: true - # name: ge-0/0/1 - # - enabled: true - # name: fe-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # vlan-tagging; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - # Using overridden - - # Before state: - # ------------- - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # vlan-tagging; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - name: Override device configuration of all interfaces with provided configuration - junipernetworks.junos.junos_interfaces: - config: - - enabled: true - name: ge-0/0/1 - - name: fe-0/0/2 - description: Configured by Ansible-2 - enabled: false - mtu: 2800 - - description: Updated by Ansible-3 - enabled: true - name: ge-0/0/3 - - enabled: true - name: fxp0 - - enabled: true - name: lo0 - state: overridden - - # Task Output - # ----------- - # - # before: - # - enabled: true - # name: ge-0/0/1 - # - enabled: true - # name: fe-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - # commands: - # - - # ge-0/0/1 - # - # - # fe-0/0/2 - # - # - # ge-0/0/3 - # - # - # fxp0 - # - # - # lo0 - # - # - # ge-0/0/1 - # fe-0/0/2 - # Configured by Ansible-2 - # 2800 - # ge-0/0/3Updated by Ansible-3 - # fxp0 - # lo0 - # after: - # - enabled: true - # name: ge-0/0/1 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: fe-0/0/2 - # - description: Updated by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # vlan-tagging; - # mtu 2800; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/3 { - # description "Updated by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - # Using replaced - - # Before state: - # ------------- - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # vlan-tagging; - # mtu 2800; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/3 { - # description "Updated by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - name: Replace device configuration of listed interfaces with provided configuration - junipernetworks.junos.junos_interfaces: - config: - - name: ge-0/0/2 - description: Configured by Ansible-2 - enabled: false - mtu: 2800 - - name: ge-0/0/3 - description: Configured by Ansible-3 - state: replaced - - # Task Output - # ----------- - # - # before: - # - enabled: true - # name: ge-0/0/1 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: fe-0/0/2 - # - description: Updated by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - # commands: - # - - # ge-0/0/2 - # - # - # ge-0/0/3 - # - # ge-0/0/2 - # Configured by Ansible-22800 - # ge-0/0/3Configured by Ansible-3 - # after: - # - enabled: true - # name: ge-0/0/1 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: fe-0/0/2 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: ge-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # vlan-tagging; - # mtu 2800; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # mtu 2800; - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - # Using gathered - - # Before state: - # ------------ - # - # vagrant@vsrx# show interfaces - # ge-0/0/1 { - # unit 0; - # } - # fe-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # vlan-tagging; - # mtu 2800; - # unit 10 { - # vlan-id 10; - # } - # unit 11 { - # vlan-id 11; - # } - # } - # ge-0/0/2 { - # description "Configured by Ansible-2"; - # disable; - # mtu 2800; - # } - # ge-0/0/3 { - # description "Configured by Ansible-3"; - # } - # fxp0 { - # unit 0 { - # family inet { - # dhcp; - # } - # } - # } - # lo0 { - # unit 0 { - # family inet { - # address 192.0.2.1/32; - # } - # } - # } - - - name: Gather junos interfaces as in given arguments - junipernetworks.junos.junos_interfaces: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - enabled: true - # name: ge-0/0/1 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: fe-0/0/2 - # - description: Configured by Ansible-2 - # enabled: false - # mtu: 2800 - # name: ge-0/0/2 - # - description: Configured by Ansible-3 - # enabled: true - # name: ge-0/0/3 - # - enabled: true - # name: fxp0 - # - enabled: true - # name: lo0 - - # Using parsed - - # parsed.cfg - # ------------ - # - # - # - # - # - # - # ge-0/0/1 - # Configured by Ansible - # - # 100m - # 1024 - # - # 2000 - # 2200 - # - # full-duplex - # - # 0 - # - # - # access - # - # vlan100 - # - # - # - # - # - # - # - # - - # - name: Convert interfaces config to structured data without connecting to the appliance - # junipernetworks.junos.junos_interfaces: - # running_config: "{{ lookup('file', './parsed.cfg') }}" - # state: parsed - - # Task Output - # ----------- - # - # parsed: - # - description: Configured by Ansible - # duplex: full-duplex - # enabled: false - # hold_time: - # down: 2200 - # up: 2000 - # mtu: 1024 - # name: ge-0/0/1 - # speed: 100m - - # Using rendered - - - name: Render platform specific xml from task input using rendered state - junipernetworks.junos.junos_interfaces: - config: - - name: ge-0/0/2 - description: Configured by Ansible - mtu: 2048 - speed: 20m - hold_time: - up: 3200 - down: 3200 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - # ge-0/0/2 - # Configured by Ansible - # 20m - # 2048 - # - # 3200 - # 3200 - # - # - # " - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-
- xml - -
- list -
- 		always -
The set of xml rpc payload pushed to the remote device.
-
-
Sample:
-
['<?xml version="1.0" encoding="UTF-8"?> <rpc-reply message-id="urn:uuid:0cadb4e8-5bba-47f4-986e-72906227007f"> <configuration changed-seconds="1590139550" changed-localtime="2020-05-22 09:25:50 UTC"> <interfaces> <interface> <name>ge-0/0/1</name> <description>Configured by Ansible</description> <disable/> <speed>100m</speed> <mtu>1024</mtu> <hold-time> <up>2000</up> <down>2200</down> </hold-time> <link-mode>full-duplex</link-mode> <unit> <name>0</name> <family> <ethernet-switching> <interface-mode>access</interface-mode> <vlan> <members>vlan100</members> </vlan> </ethernet-switching> </family> </unit> </interface> </interfaces> </configuration> </rpc-reply>', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/junipernetworks.junos.junos_l2_interfaces_module.rst b/docs/junipernetworks.junos.junos_l2_interfaces_module.rst deleted file mode 100644 index b6f422db..00000000 --- a/docs/junipernetworks.junos.junos_l2_interfaces_module.rst +++ /dev/null @@ -1,1213 +0,0 @@ -.. _junipernetworks.junos.junos_l2_interfaces_module: - - -***************************************** -junipernetworks.junos.junos_l2_interfaces -***************************************** - -**L2 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of a Layer-2 interface on Juniper JUNOS devices. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-2 interface options
-
-
- access - -
- dictionary -
- 		- -
Configure the interface as a Layer 2 access mode.
-
-
- vlan - -
- string -
- 		- -
Configure the access VLAN ID.
-
-
- enhanced_layer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
True if your device has Enhanced Layer 2 Software (ELS). If the l2 configuration is under interface-mode the value is True else if the l2 configuration is under port-mode value is False
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, e.g. ge-0/0/1.
-
-
- trunk - -
- dictionary -
- 		- -
Configure the interface as a Layer 2 trunk mode.
-
-
- allowed_vlans - -
- list - / elements=string -
- 		- -
List of VLANs to be configured in trunk port. It's used as the VLAN range to ADD or REMOVE from the trunk.
-
-
- native_vlan - -
- string -
- 		- -
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
-
-
- unit - -
- integer -
- 		- -
Logical interface number. Value of unit should be of type integer.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show interfaces.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 18.4R1. - - This module works with connection ``netconf``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_junos.html - - The module examples uses callback plugin (stdout_callback = yaml) to generate task output in yaml format. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # ansible@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # } - # } - # } - # ge-0/0/4 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - - name: Merge provided configuration with device configuration - junipernetworks.junos.junos_l2_interfaces: - config: - - name: ge-0/0/3 - access: - vlan: v101 - - name: ge-0/0/4 - trunk: - allowed_vlans: - - vlan30 - native_vlan: 50 - state: merged - - # Task Output - # ----------- - # - # before: - # - enhanced_layer: true - # name: ge-0/0/3 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/4 - # unit: 0 - # commands: - # - - # - # ge-0/0/3 - # - # 0 - # - # - # access - # - # v101 - # - # - # - # - # - # - # ge-0/0/4 - # - # 0 - # - # - # trunk - # - # vlan30 - # - # - # - # - # 50 - # - # - # after: - # - access: - # vlan: v101 - # enhanced_layer: true - # name: ge-0/0/3 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - vlan30 - # native_vlan: '50' - # unit: 0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # vlan { - # members v101; - # } - # } - # } - # } - # ge-0/0/4 { - # native-vlan-id 50; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members vlan30; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - - # Using overridden - - # Before state: - # ------------- - # ansible@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # vlan { - # members v101; - # } - # } - # } - # } - # ge-0/0/4 { - # native-vlan-id 50; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members vlan30; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - - name: Override provided configuration with device configuration - junipernetworks.junos.junos_l2_interfaces: - config: - - name: ge-0/0/4 - trunk: - allowed_vlans: - - v101 - native_vlan: 30 - state: overridden - - # Task Output - # ----------- - # - # before: - # - access: - # vlan: v101 - # enhanced_layer: true - # name: ge-0/0/3 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - vlan30 - # native_vlan: '50' - # unit: 0 - # commands: - # - - # - # ge-0/0/4 - # - # 0 - # - # - # - # - # - # - # - # - # - # - # ge-0/0/4 - # - # 0 - # - # - # trunk - # - # v101 - # - # - # - # - # 30 - # - # - # ge-0/0/3 - # - # 0 - # - # - # - # - # - # - # - # - # - # - # after: - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - v101 - # native_vlan: '30' - # unit: 0 - - # After state: - # ------------ - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching; - # } - # } - # ge-0/0/4 { - # native-vlan-id 30; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members v101; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - # Using replaced - - # Before state: - # ------------- - # - # ansible@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching; - # } - # } - # ge-0/0/4 { - # native-vlan-id 30; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members v101; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - - name: Replace provided configuration with device configuration - junipernetworks.junos.junos_l2_interfaces: - config: - - name: ge-0/0/3 - access: - vlan: v101 - - name: ge-0/0/4 - trunk: - allowed_vlans: - - vlan30 - native_vlan: 50 - state: replaced - - # Task Output - # ----------- - # - # before: - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - v101 - # native_vlan: '30' - # unit: 0 - # commands: - # - - # - # ge-0/0/4 - # - # 0 - # - # - # - # - # - # - # - # - # - # - # ge-0/0/3 - # - # 0 - # - # - # access - # - # v101 - # - # - # - # - # - # - # ge-0/0/4 - # - # 0 - # - # - # trunk - # - # vlan30 - # - # - # - # - # 50 - # - # - # after: - # - access: - # vlan: v101 - # enhanced_layer: true - # name: ge-0/0/3 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - vlan30 - # native_vlan: '50' - # unit: 0 - - # After state: - # ------------ - # - # user@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # vlan { - # members v101; - # } - # } - # } - # } - # ge-0/0/4 { - # native-vlan-id 50; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members vlan30; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - # Using deleted - - # Before state: - # ------------- - # - # ansible@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # vlan { - # members v101; - # } - # } - # } - # } - # ge-0/0/4 { - # native-vlan-id 50; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members vlan30; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - - name: "Delete L2 attributes of given interfaces (Note: This won't delete the - interface itself)." - junipernetworks.junos.junos_l2_interfaces: - config: - - name: ge-0/0/1 - - name: ge-0/0/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - access: - # vlan: v101 - # enhanced_layer: true - # name: ge-0/0/3 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - vlan30 - # native_vlan: '50' - # unit: 0 - # commands: - # - - # - # ge-0/0/3 - # - # 0 - # - # - # - # - # - # - # - # - # - # - # after: - # - enhanced_layer: true - # name: ge-0/0/4 - # trunk: - # allowed_vlans: - # - vlan30 - # native_vlan: '50' - # unit: 0 - - # After state: - # ------------ - # - # ansible@junos01# show interfaces - # ge-0/0/1 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/2 { - # unit 0 { - # family inet; - # family inet6; - # } - # } - # ge-0/0/3 { - # unit 0 { - # family ethernet-switching; - # } - # } - # ge-0/0/4 { - # native-vlan-id 50; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members vlan30; - # } - # } - # } - # } - # fxp0 { - # enable; - # unit 0 { - # family inet { - # dhcp; - # } - # family inet6; - # } - # } - - # Using gathered - - # Before state: - # ------------- - # - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Configured by Ansible"; - # disable; - # speed 100m; - # mtu 1024; - # hold-time up 2000 down 2200; - # link-mode full-duplex; - # unit 0 { - # family ethernet-switching { - # interface-mode access; - # vlan { - # members vlan100; - # } - # } - # } - # } - # ge-0/0/2 { - # description "Configured by Ansible"; - # native-vlan-id 400; - # speed 10m; - # mtu 2048; - # hold-time up 3000 down 3200; - # unit 0 { - # family ethernet-switching { - # interface-mode trunk; - # vlan { - # members [ vlan200 vlan300 ]; - # } - # } - # } - # } - # em1 { - # description TEST; - # } - # fxp0 { - # description ANSIBLE; - # speed 1g; - # link-mode automatic; - # unit 0 { - # family inet { - # address 10.8.38.38/24; - # } - # } - # } - - - name: Gather junos layer 2 interfaces facts - junipernetworks.junos.junos_l2_interfaces: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - access: - # vlan: vlan100 - # enhanced_layer: true - # name: ge-0/0/1 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/2 - # trunk: - # allowed_vlans: - # - vlan200 - # - vlan300 - # native_vlan: '400' - # unit: 0 - - # Using parsed - - # parsed.cfg - # ------------ - # - # - # - # - # - # - # ge-0/0/1 - # Configured by Ansible - # - # 100m - # 1024 - # - # 2000 - # 2200 - # - # full-duplex - # - # 0 - # - # - # access - # - # vlan100 - # - # - # - # - # - # - # - # - - - name: Convert interfaces config to argspec without connecting to the appliance - junipernetworks.junos.junos_l2_interfaces: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task Output - # ----------- - # - # parsed: - # - access: - # vlan: vlan100 - # enhanced_layer: true - # name: ge-0/0/1 - # unit: 0 - # - enhanced_layer: true - # name: ge-0/0/2 - # trunk: - # allowed_vlans: - # - vlan200 - # - vlan300 - # native_vlan: '400' - # unit: 0 - - # Using rendered - - - name: Render platform specific xml from task input using rendered state - junipernetworks.junos.junos_l2_interfaces: - config: - - name: ge-0/0/1 - access: - vlan: vlan100 - - name: ge-0/0/2 - trunk: - allowed_vlans: - - vlan200 - - vlan300 - native_vlan: '400' - state: rendered - - # Task Output - # ----------- - # - # "rendered": " - # - # ge-0/0/1 - # - # 0 - # - # - # access - # - # vlan100 - # - # - # - # - # - # - # ge-0/0/2 - # - # 0 - # - # - # trunk - # - # vlan200 - # vlan300 - # - # - # - # - # 400 - # - # " - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:interface> <nc:name>ge-0/0/1</nc:name> <nc:unit> <nc:name>0</nc:name> <nc:family> <nc:ethernet-switching> <nc:interface-mode>access</nc:interface-mode> <nc:vlan> <nc:members>vlan100</nc:members> </nc:vlan> </nc:ethernet-switching> </nc:family> </nc:unit> </nc:interface> <nc:interface> <nc:name>ge-0/0/2</nc:name> <nc:unit> <nc:name>0</nc:name> <nc:family> <nc:ethernet-switching> <nc:interface-mode>trunk</nc:interface-mode> <nc:vlan> <nc:members>vlan200</nc:members> <nc:members>vlan300</nc:members> </nc:vlan> </nc:ethernet-switching> </nc:family> </nc:unit> <nc:native-vlan-id>400</nc:native-vlan-id> </nc:interface> </nc:interfaces>', 'xml 2', 'xml 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/junipernetworks.junos.junos_lacp_interfaces_module.rst b/docs/junipernetworks.junos.junos_lacp_interfaces_module.rst deleted file mode 100644 index 3e411522..00000000 --- a/docs/junipernetworks.junos.junos_lacp_interfaces_module.rst +++ /dev/null @@ -1,1100 +0,0 @@ -.. _junipernetworks.junos.junos_lacp_interfaces_module: - - -******************************************* -junipernetworks.junos.junos_lacp_interfaces -******************************************* - -**LACP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Link Aggregation Control Protocol (LACP) attributes of interfaces on Juniper JUNOS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The list of dictionaries of LACP interfaces options.
-
-
- force_up - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This is a boolean argument to control if the port should be up in absence of received link Aggregation Control Protocol Data Unit (LACPDUS). This value is applicable for member interfaces only.
-
-
- name - -
- string -
- 		- -
Name Identifier of the interface or link aggregation group.
-
-
- period - -
- string -
- 		-
    Choices: -
  • fast
    • -
  • slow
    • -
- 		-
Timer interval for periodic transmission of LACP packets. If the value is set to fast the packets are received every second and if the value is slow the packets are received every 30 seconds. This value is applicable for aggregate interface only.
-
-
- port_priority - -
- integer -
- 		- -
Priority of the member port. This value is applicable for member interfaces only.
-
Refer to vendor documentation for valid values.
-
-
- sync_reset - -
- string -
- 		-
    Choices: -
  • disable
    • -
  • enable
    • -
- 		-
The argument notifies minimum-link failure out of sync to peer. If the value is disable it disables minimum-link failure handling at LACP level and if value is enable it enables minimum-link failure handling at LACP level. This value is applicable for aggregate interface only.
-
-
- system - -
- dictionary -
- 		- -
This dict object contains configurable options related to LACP system parameters for the link aggregation group. This value is applicable for aggregate interface only.
-
-
- mac - -
- dictionary -
- 		- -
Specifies the system ID to use in LACP negotiations for the bundle, encoded as a MAC address.
-
-
- address - -
- string -
- 		- -
The system ID to use in LACP negotiations.
-
-
- priority - -
- integer -
- 		- -
Specifies the system priority to use in LACP negotiations for the bundle.
-
Refer to vendor documentation for valid values.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state of the configuration after module completion.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad ae0; - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - - name: Merge provided configuration with device configuration - junipernetworks.junos.junos_lacp_interfaces: - config: - - name: ae0 - period: fast - sync_reset: enable - system: - priority: 100 - mac: - address: 00:00:00:00:00:02 - - name: ge-0/0/3 - port_priority: 100 - force_up: true - state: merged - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # periodic fast; - # sync-reset enable; - # system-priority 100; - # system-id 00:00:00:00:00:02; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - # Using replaced - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # periodic fast; - # sync-reset enable; - # system-priority 100; - # system-id 00:00:00:00:00:02; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - - name: Replace device LACP interfaces configuration with provided configuration - junipernetworks.junos.junos_lacp_interfaces: - config: - - name: ae0 - period: slow - state: replaced - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # periodic slow; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - # Using overridden - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # periodic slow; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - - name: Overrides all device LACP interfaces configuration with provided configuration - junipernetworks.junos.junos_lacp_interfaces: - config: - - name: ae0 - system: - priority: 300 - mac: - address: 00:00:00:00:00:03 - - name: ge-0/0/2 - port_priority: 200 - force_up: false - state: overridden - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad { - # lacp { - # port-priority 200; - # } - # ae4; - # } - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # system-priority 300; - # system-id 00:00:00:00:00:03; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - # Using deleted - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad { - # lacp { - # port-priority 200; - # } - # ae4; - # } - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae0; - # } - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # system-priority 300; - # system-id 00:00:00:00:00:03; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - - - name: "Delete LACP interfaces attributes of given interfaces (Note: This won't delete the interface itself)" - junipernetworks.junos.junos_lacp_interfaces: - config: - - name: ae0 - - name: ge-0/0/3 - - name: ge-0/0/2 - state: deleted - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/2 { - # ether-options { - # 802.3ad ae4; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad ae0; - # } - # } - # ae0 { - # description "lag interface merged"; - # aggregated-ether-options { - # lacp { - # passive; - # } - # } - # } - # ae4 { - # description "test aggregate interface"; - # aggregated-ether-options { - # lacp { - # passive; - # link-protection; - # } - # } - # } - # Using gathered - # Before state: - # ------------ - # - # user@junos01# show interfaces - # ansible@cm123456tr21# show interfaces - # ge-0/0/1 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae1; - # } - # } - # } - # ge-0/0/2 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad ae2; - # } - # } - # ge-0/0/4 { - # ether-options { - # 802.3ad ae2; - # } - # } - # ge-1/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.1/24; - # address 10.200.16.20/24; - # } - # family inet6; - # } - # } - # ge-2/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.2/24; - # address 10.200.16.21/24; - # } - # family inet6; - # } - # } - # ge-3/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.3/24; - # address 10.200.16.22/24; - # } - # family inet6; - # } - # } - # ae1 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # lacp { - # periodic fast; - # sync-reset enable; - # system-priority 100; - # system-id 00:00:00:00:00:02; - # } - # } - # } - # ae2 { - # description "Configured by Ansible"; - # } - # em1 { - # description TEST; - # } - # fxp0 { - # description ANSIBLE; - # speed 1g; - # link-mode automatic; - # unit 0 { - # family inet { - # address 10.8.38.38/24; - # } - # } - # } - - name: Gather junos lacp interfaces as in given arguments - junipernetworks.junos.junos_lacp_interfaces: - state: gathered - # Task Output (redacted) - # ----------------------- - # - # "gathered": [ - # { - # "force_up": true, - # "name": "ge-0/0/1", - # "port_priority": 100 - # }, - # { - # "name": "ae1", - # "period": "fast", - # "sync_reset": "enable", - # "system": { - # "mac": { - # "address": "00:00:00:00:00:02" - # }, - # "priority": 100 - # } - # } - # ] - # After state: - # ------------ - # - # ansible@cm123456tr21# show interfaces - # ge-0/0/1 { - # ether-options { - # 802.3ad { - # lacp { - # force-up; - # port-priority 100; - # } - # ae1; - # } - # } - # } - # ge-0/0/2 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad ae2; - # } - # } - # ge-0/0/4 { - # ether-options { - # 802.3ad ae2; - # } - # } - # ge-1/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.1/24; - # address 10.200.16.20/24; - # } - # family inet6; - # } - # } - # ge-2/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.2/24; - # address 10.200.16.21/24; - # } - # family inet6; - # } - # } - # ge-3/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.3/24; - # address 10.200.16.22/24; - # } - # family inet6; - # } - # } - # ae1 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # lacp { - # periodic fast; - # sync-reset enable; - # system-priority 100; - # system-id 00:00:00:00:00:02; - # } - # } - # } - # ae2 { - # description "Configured by Ansible"; - # } - # em1 { - # description TEST; - # } - # fxp0 { - # description ANSIBLE; - # speed 1g; - # link-mode automatic; - # unit 0 { - # family inet { - # address 10.8.38.38/24; - # } - # } - # } - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # - # - # - # ge-0/0/1 - # - # - # - # - # 100 - # - # ae1 - # - # - # - # - # ge-0/0/2 - # - # - # ae1 - # - # - # - # - # ge-0/0/3 - # - # - # ae2 - # - # - # - # - # ge-0/0/4 - # - # - # ae2 - # - # - # - # - # ge-1/0/0 - # - # 0 - # - # - #
- # 192.168.100.1/24 - #
- #
- # 10.200.16.20/24 - #
- # - # - # - # - # - # - # - # ge-2/0/0 - # - # 0 - # - # - #
- # 192.168.100.2/24 - #
- #
- # 10.200.16.21/24 - #
- # - # - # - # - # - # - # - # ge-3/0/0 - # - # 0 - # - # - #
- # 192.168.100.3/24 - #
- #
- # 10.200.16.22/24 - #
- # - # - # - # - # - # - # - # ae1 - # Configured by Ansible - # - # - # fast - # enable - # 100 - # 00:00:00:00:00:02 - # - # - # - # - # ae2 - # Configured by Ansible - # - # - # em1 - # TEST - # - # - # fxp0 - # ANSIBLE - # 1g - # automatic - # - # 0 - # - # - #
- # 10.8.38.38/24 - #
- # - # - # - # - # - # - # - # - name: Convert interfaces config to argspec without connecting to the appliance - # junipernetworks.junos.junos_lacp_interfaces: - # running_config: "{{ lookup('file', './parsed.cfg') }}" - # state: parsed - # Task Output (redacted) - # ----------------------- - # "parsed": [ - # { - # "force_up": true, - # "name": "ge-0/0/1", - # "port_priority": 100 - # }, - # { - # "name": "ae1", - # "period": "fast", - # "sync_reset": "enable", - # "system": { - # "mac": { - # "address": "00:00:00:00:00:02" - # }, - # "priority": 100 - # } - # } - # ] - # Using rendered - - name: Render platform specific xml from task input using rendered state - junipernetworks.junos.junos_lacp_interfaces: - config: - - name: ae1 - period: fast - sync_reset: enable - system: - priority: 100 - mac: - address: 00:00:00:00:00:02 - - - name: ge-0/0/1 - port_priority: 100 - force_up: true - state: rendered - # Task Output (redacted) - # ----------------------- - # "rendered": " - # - # ae1 - # - # - # fast - # enable - # 00:00:00:00:00:02 - # 100 - # - # - # - # - # ge-0/0/1 - # - # - # - # 100 - # - # - # - # - # - # " - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:interface> <nc:name>ae1</nc:name> <nc:aggregated-ether-options> <nc:lacp> <nc:periodic>fast</nc:periodic> <nc:sync-reset>enable</nc:sync-reset> <nc:system-id>00:00:00:00:00:02</nc:system-id> <nc:system-priority>100</nc:system-priority> </nc:lacp> </nc:aggregated-ether-options> </nc:interface> <nc:interface> <nc:name>ge-0/0/1</nc:name> <nc:ether-options> <nc:ieee-802.3ad> <nc:lacp> <nc:port-priority>100</nc:port-priority> <nc:force-up/> </nc:lacp> </nc:ieee-802.3ad> </nc:ether-options> </nc:interface> </nc:interfaces>', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/junipernetworks.junos.junos_lag_interfaces_module.rst b/docs/junipernetworks.junos.junos_lag_interfaces_module.rst deleted file mode 100644 index 777407ba..00000000 --- a/docs/junipernetworks.junos.junos_lag_interfaces_module.rst +++ /dev/null @@ -1,987 +0,0 @@ -.. _junipernetworks.junos.junos_lag_interfaces_module: - - -****************************************** -junipernetworks.junos.junos_lag_interfaces -****************************************** - -**Link Aggregation Juniper JUNOS resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages properties of Link Aggregation Group on Juniper JUNOS devices. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of link aggregation group configurations.
-
-
- link_protection - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This boolean option indicates if link protection should be enabled for the LAG interface. If value is True link protection is enabled on LAG and if value is False link protection is disabled.
-
-
- members - -
- list - / elements=dictionary -
- 		- -
List of member interfaces of the link aggregation group. The value can be single interface or list of interfaces.
-
-
- ether_option_type - -
- string -
- 		-
    Choices: -
  • ether ←
    • -
  • gigether
    • -
- 		-
Specify the type of ethernet interface.
-
-
- link_type - -
- string -
- 		-
    Choices: -
  • primary
    • -
  • backup
    • -
- 		-
The value of this options configures the member link as either primary or backup. Value primary configures primary interface for link-protection mode and backup configures backup interface for link-protection mode.
-
-
- member - -
- string -
- 		- -
Name of the member interface.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • active
    • -
  • passive
    • -
- 		-
LAG mode. A value of passive will enable LACP in passive mode that is it will respond to LACP packets and active configures the link to initiate transmission of LACP packets.
-
-
- name - -
- string - / required -
- 		- -
Name of the link aggregation group (LAG).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show interfaces.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 18.4R1. - - This module works with connection ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ae0 { - # description "lag interface"; - # } - # ae1 { - # description "lag interface 1"; - # } - - - name: "Delete LAG attributes of given interfaces (Note: This won't delete the interface itself)" - junipernetworks.junos.junos_lag_interfaces: - config: - - name: ae0 - - name: ae1 - state: deleted - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # } - - - # Using merged - - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # } - - - name: Merge provided configuration with device configuration - junipernetworks.junos.junos_lag_interfaces: - config: - - name: ae0 - members: - - member: ge-0/0/1 - link_type: primary - - member: ge-0/0/2 - link_type: backup - state: merged - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # ether-options { - # 802.3ad { - # ae0; - # primary; - # } - # } - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # ether-options { - # 802.3ad { - # ae0; - # backup; - # } - # } - # } - - - # Using merged - - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ae0 { - # description "lag interface"; - # } - # ae3 { - # description "lag interface 3"; - # } - - - name: Overrides all device LAG configuration with provided configuration - junipernetworks.junos.junos_lag_interfaces: - config: - - name: ae0 - members: - - member: ge-0/0/2 - - name: ae1 - members: - - member: ge-0/0/1 - mode: passive - state: overridden - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ae0 { - # description "lag interface"; - # } - # ae1 { - # aggregated-ether-options { - # lacp { - # active; - # } - # } - # } - - - # Using merged - - # Before state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # } - # ge-0/0/3 { - # description "Ansible configured interface 3"; - # } - - - name: Replace device LAG configuration with provided configuration - junipernetworks.junos.junos_lag_interfaces: - config: - - name: ae0 - members: - - member: ge-0/0/1 - mode: active - state: replaced - - # After state: - # ------------- - # user@junos01# show interfaces - # ge-0/0/1 { - # description "Ansible configured interface 1"; - # ether-options { - # 802.3ad ae0; - # } - # } - # ge-0/0/2 { - # description "Ansible configured interface 2"; - # } - # ae0 { - # aggregated-ether-options { - # lacp { - # active; - # } - # } - # } - # ge-0/0/3 { - # description "Ansible configured interface 3"; - # } - # Using gathered - # Before state: - # ------------ - # - # ansible@cm123456tr21# show interfaces - # ge-0/0/1 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/2 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # ae2; - # primary; - # } - # } - # } - # ge-0/0/4 { - # ether-options { - # 802.3ad { - # ae2; - # backup; - # } - # } - # } - # ge-1/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.1/24; - # address 10.200.16.20/24; - # } - # family inet6; - # } - # } - # ge-2/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.2/24; - # address 10.200.16.21/24; - # } - # family inet6; - # } - # } - # ge-3/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.3/24; - # address 10.200.16.22/24; - # } - # family inet6; - # } - # } - # ae1 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # lacp { - # active; - # } - # } - # } - # ae2 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # link-protection; - # lacp { - # passive; - # } - # } - # } - # em1 { - # description TEST; - # } - # fxp0 { - # description ANSIBLE; - # speed 1g; - # link-mode automatic; - # unit 0 { - # family inet { - # address 10.8.38.38/24; - # } - # } - # } - - name: Gather junos lag interfaces as in given arguments - junipernetworks.junos.junos_lag_interfaces: - state: gathered - # Task Output (redacted) - # ----------------------- - # - # "gathered": [ - # { - # "members": [ - # { - # "member": "ge-0/0/1" - # }, - # { - # "member": "ge-0/0/2" - # } - # ], - # "mode": "active", - # "name": "ae1" - # }, - # { - # "link_protection": true, - # "members": [ - # { - # "link_type": "primary", - # "member": "ge-0/0/3" - # }, - # { - # "link_type": "backup", - # "member": "ge-0/0/4" - # } - # ], - # "mode": "passive", - # "name": "ae2" - # } - # ] - # After state: - # ------------ - # - # ansible@cm123456tr21# show interfaces - # ge-0/0/1 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/2 { - # ether-options { - # 802.3ad ae1; - # } - # } - # ge-0/0/3 { - # ether-options { - # 802.3ad { - # ae2; - # primary; - # } - # } - # } - # ge-0/0/4 { - # ether-options { - # 802.3ad { - # ae2; - # backup; - # } - # } - # } - # ge-1/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.1/24; - # address 10.200.16.20/24; - # } - # family inet6; - # } - # } - # ge-2/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.2/24; - # address 10.200.16.21/24; - # } - # family inet6; - # } - # } - # ge-3/0/0 { - # unit 0 { - # family inet { - # address 192.168.100.3/24; - # address 10.200.16.22/24; - # } - # family inet6; - # } - # } - # ae1 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # lacp { - # active; - # } - # } - # } - # ae2 { - # description "Configured by Ansible"; - # aggregated-ether-options { - # link-protection; - # lacp { - # passive; - # } - # } - # } - # em1 { - # description TEST; - # } - # fxp0 { - # description ANSIBLE; - # speed 1g; - # link-mode automatic; - # unit 0 { - # family inet { - # address 10.8.38.38/24; - # } - # } - # } - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # - # - # - # ge-0/0/1 - # - # - # ae1 - # - # - # - # - # ge-0/0/2 - # - # - # ae1 - # - # - # - # - # ge-0/0/3 - # - # - # ae2 - # - # - # - # - # - # ge-0/0/4 - # - # - # ae2 - # - # - # - # - # - # ge-1/0/0 - # - # 0 - # - # - #
- # 192.168.100.1/24 - #
- #
- # 10.200.16.20/24 - #
- # - # - # - # - # - # - # - # ge-2/0/0 - # - # 0 - # - # - #
- # 192.168.100.2/24 - #
- #
- # 10.200.16.21/24 - #
- # - # - # - # - # - # - # - # ge-3/0/0 - # - # 0 - # - # - #
- # 192.168.100.3/24 - #
- #
- # 10.200.16.22/24 - #
- # - # - # - # - # - # - # - # ae1 - # Configured by Ansible - # - # - # - # - # - # - # - # ae2 - # Configured by Ansible - # - # - # - # - # - # - # - # - # - # em1 - # TEST - # - # - # fxp0 - # ANSIBLE - # 1g - # automatic - # - # 0 - # - # - #
- # 10.8.38.38/24 - #
- # - # - # - # - # - # - # - # - name: Convert interfaces config to argspec without connecting to the appliance - # junipernetworks.junos.junos_lag_interfaces: - # running_config: "{{ lookup('file', './parsed.cfg') }}" - # state: parsed - # Task Output (redacted) - # ----------------------- - # "parsed": [ - # { - # "members": [ - # { - # "member": "ge-0/0/1" - # }, - # { - # "member": "ge-0/0/2" - # } - # ], - # "mode": "active", - # "name": "ae1" - # }, - # { - # "link_protection": true, - # "members": [ - # { - # "link_type": "primary", - # "member": "ge-0/0/3" - # }, - # { - # "link_type": "backup", - # "member": "ge-0/0/4" - # } - # ], - # "mode": "passive", - # "name": "ae2" - # } - # ] - # Using rendered - - name: Render platform specific xml from task input using rendered state - junipernetworks.junos.junos_lag_interfaces: - config: - - name: ae1 - members: - - member: ge-0/0/1 - - member: ge-0/0/2 - mode: active - - - name: ae2 - link_protection: true - members: - - member: ge-0/0/3 - link_type: primary - - member: ge-0/0/4 - link_type: backup - mode: passive - # Task Output (redacted) - # ----------------------- - # "rendered": " - # - # ae1 - # - # - # - # - # - # - # - # ge-0/0/1 - # - # - # ae1 - # - # - # - # - # ge-0/0/2 - # - # - # ae1 - # - # - # - # - # ae2 - # - # - # - # - # - # - # - # - # ge-0/0/3 - # - # - # ae2 - # - # - # - # - # - # ge-0/0/4 - # - # - # ae2 - # - # - # - # - # " - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- xml - -
- list -
- 		always -
The set of xml rpc payload pushed to the remote device.
-
-
Sample:
-
['<nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:interface> <nc:name>ae1</nc:name> <nc:aggregated-ether-options> <nc:lacp> <nc:active/> </nc:lacp> </nc:aggregated-ether-options> </nc:interface> <nc:interface> <nc:name>ge-0/0/1</nc:name> <nc:ether-options> <nc:ieee-802.3ad> <nc:bundle>ae1</nc:bundle> </nc:ieee-802.3ad> </nc:ether-options> </nc:interface> <nc:interface> <nc:name>ge-0/0/2</nc:name> <nc:ether-options> <nc:ieee-802.3ad> <nc:bundle>ae1</nc:bundle> </nc:ieee-802.3ad> </nc:ether-options> </nc:interface> <nc:interface> <nc:name>ae2</nc:name> <nc:aggregated-ether-options> <nc:lacp> <nc:passive/> </nc:lacp> <nc:link-protection/> </nc:aggregated-ether-options> </nc:interface> <nc:interface> <nc:name>ge-0/0/3</nc:name> <nc:ether-options> <nc:ieee-802.3ad> <nc:bundle>ae2</nc:bundle> <nc:primary/> </nc:ieee-802.3ad> </nc:ether-options> </nc:interface> <nc:interface> <nc:name>ge-0/0/4</nc:name> <nc:ether-options> <nc:ieee-802.3ad> <nc:bundle>ae2</nc:bundle> <nc:backup/> </nc:ieee-802.3ad> </nc:ether-options> </nc:interface> </nc:interfaces>', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/junipernetworks.junos.junos_lldp_global_module.rst b/docs/junipernetworks.junos.junos_lldp_global_module.rst deleted file mode 100644 index 28e9a7d8..00000000 --- a/docs/junipernetworks.junos.junos_lldp_global_module.rst +++ /dev/null @@ -1,444 +0,0 @@ -.. _junipernetworks.junos.junos_lldp_global_module: - - -*************************************** -junipernetworks.junos.junos_lldp_global -*************************************** - -**LLDP resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages link layer discovery protocol (LLDP) attributes on Juniper JUNOS devices. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
The list of link layer discovery protocol attribute configurations
-
-
- address - -
- string -
- 		- -
This argument sets the management address from LLDP.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This argument is a boolean value to enabled or disable LLDP.
-
-
- hold_multiplier - -
- integer -
- 		- -
Specify the number of seconds that LLDP information is held before it is discarded. The multiplier value is used in combination with the interval value.
-
-
- interval - -
- integer -
- 		- -
Frequency at which LLDP advertisements are sent (in seconds).
-
-
- transmit_delay - -
- integer -
- 		- -
Specify the number of seconds the device waits before sending advertisements to neighbors after a change is made in local system.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show protocols lldp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 18.4R1. - - This module works with connection ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # Before state: - # ------------- - # user@junos01# # show protocols lldp - # - - name: Merge provided configuration with device configuration - junipernetworks.junos.junos_lldp_global: - config: - interval: 10000 - address: 10.1.1.1 - transmit_delay: 400 - hold_multiplier: 10 - state: merged - - # After state: - # ------------- - # user@junos01# show protocols lldp - # management-address 10.1.1.1; - # advertisement-interval 10000; - # transmit-delay 400; - # hold-multiplier 10; - - # Using replaced - # Before state: - # ------------- - # user@junos01# show protocols lldp - # management-address 10.1.1.1; - # advertisement-interval 10000; - # transmit-delay 400; - # hold-multiplier 10; - - - name: Replace provided configuration with device configuration - junipernetworks.junos.junos_lldp_global: - config: - address: 20.2.2.2 - hold_multiplier: 30 - enabled: false - state: replaced - - # After state: - # ------------- - # user@junos01# show protocols lldp - # disable; - # management-address 20.2.2.2; - # hold-multiplier 30; - - # Using deleted - # Before state: - # ------------- - # user@junos01# show protocols lldp - # management-address 20.2.2.2; - # hold-multiplier 30; - - - name: Delete lldp configuration (this will by default remove all lldp configuration) - junipernetworks.junos.junos_lldp_global: - state: deleted - - # After state: - # ------------- - # user@junos01# # show protocols lldp - # - # - # Using gathered - # Before state: - # ------------ - # - # ansible@cm123456tr21# show protocols lldp - # management-address 10.1.1.1; - # advertisement-interval 10000; - # transmit-delay 400; - # hold-multiplier 10; - # interface ge-0/0/1; - # interface ge-0/0/2 { - # disable; - # } - - name: Gather junos lldp_global as in given arguments - junipernetworks.junos.junos_lldp_global: - state: gathered - # Task Output (redacted) - # ----------------------- - # - # "gathered": { - # "address": "10.1.1.1", - # "hold_multiplier": 10, - # "interval": 10000, - # "transmit_delay": 400 - # } - # After state: - # ------------ - # - # ansible@cm123456tr21# show protocols lldp - # management-address 10.1.1.1; - # advertisement-interval 10000; - # transmit-delay 400; - # hold-multiplier 10; - # interface ge-0/0/1; - # interface ge-0/0/2 { - # disable; - # } - # Using rendered - - name: Render platform specific xml from task input using rendered state - junipernetworks.junos.junos_lldp_global: - config: - interval: 10000 - address: 10.1.1.1 - transmit_delay: 400 - hold_multiplier: 10 - state: rendered - # Task Output (redacted) - # ----------------------- - # "rendered": " - # - # 10.1.1.1 - # 10000 - # 400 - # 10 - # - # - # " - # - # parsed.cfg - # ------------ - # - # - # - # - # - # - # - # 0.0.0.0 - # - # ge-0/0/0.0 - # - # - # - # - # 10.1.1.1 - # 10000 - # 400 - # 10 - # - # ge-0/0/1 - # - # - # ge-0/0/2 - # - # - # - # - # - # - # - name: Convert lldp global config to argspec without connecting to the appliance - # junipernetworks.junos.junos_lldp_global: - # running_config: "{{ lookup('file', './parsed.cfg') }}" - # state: parsed - # Task Output (redacted) - # ----------------------- - # "parsed": { - # "address": "10.1.1.1", - # "hold_multiplier": 10, - # "interval": 10000, - # "transmit_delay": 400 - # } - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:lldp> <nc:management-address>10.1.1.1</nc:management-address> <nc:advertisement-interval>10000</nc:advertisement-interval> <nc:transmit-delay>400</nc:transmit-delay> <nc:hold-multiplier>10</nc:hold-multiplier> <nc:disable delete="delete"/> </nc:lldp> </nc:protocols>', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/junipernetworks.junos.junos_logging_global_module.rst b/docs/junipernetworks.junos.junos_logging_global_module.rst deleted file mode 100644 index 26c5903b..00000000 --- a/docs/junipernetworks.junos.junos_logging_global_module.rst +++ /dev/null @@ -1,5615 +0,0 @@ -.. _junipernetworks.junos.junos_logging_global_module: - - -****************************************** -junipernetworks.junos.junos_logging_global -****************************************** - -**Manage logging configuration on Junos devices.** - - -Version added: 2.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages logging configuration on devices running Junos. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of logging configuration.
-
-
- allow_duplicates - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not suppress the repeated message for all targets.
-
-
- archive - -
- dictionary -
- 		- -
Specify archive file information.
-
-
- binary_data - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mark file as if it contains binary data.
-
-
- file_size - -
- string -
- 		- -
Size of files to be archived (65536..1073741824 bytes).
-
-
- files - -
- integer -
- 		- -
Specify number of files to be archived (1..1000).
-
-
- no_binary_data - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't mark file as if it contains binary data.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set archive file information.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- console - -
- dictionary -
- 		- -
Set console logging parameters.
-
-
- any - -
- dictionary -
- 		- -
Set All facilities.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- authorization - -
- dictionary -
- 		- -
Specify authorization system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- change_log - -
- dictionary -
- 		- -
Specify configuration change log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- conflict_log - -
- dictionary -
- 		- -
Specify configuration conflict log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- daemon - -
- dictionary -
- 		- -
Specify various system processes.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- dfc - -
- dictionary -
- 		- -
Specify dynamic flow capture.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- external - -
- dictionary -
- 		- -
Specify Local external applications.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- firewall - -
- dictionary -
- 		- -
Specify Firewall filtering system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- ftp - -
- dictionary -
- 		- -
Specify FTP process.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- interactive_commands - -
- dictionary -
- 		- -
Specify commands executed by the UI.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- kernel - -
- dictionary -
- 		- -
Specify Kernel specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- ntp - -
- dictionary -
- 		- -
Specify NTP process specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- pfe - -
- dictionary -
- 		- -
Specify Packet Forwarding Engine specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- security - -
- dictionary -
- 		- -
Specify Security related logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- user - -
- dictionary -
- 		- -
Specify user specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- files - -
- list - / elements=dictionary -
- 		- -
Specify files logging.
-
-
- allow_duplicates - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not suppress the repeated message for all targets.
-
-
- any - -
- dictionary -
- 		- -
Set All facilities.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- archive - -
- dictionary -
- 		- -
Specify archive file information.
-
-
- archive_sites - -
- list - / elements=string -
- 		- -
Specify Primary and failover URLs to receive archive facilities.
-
-
- binary_data - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mark file as if it contains binary data.
-
-
- file_size - -
- string -
- 		- -
Size of files to be archived (65536..1073741824 bytes).
-
-
- files - -
- integer -
- 		- -
Specify number of files to be archived (1..1000).
-
-
- no_binary_data - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't mark file as if it contains binary data.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set archive file information.
-
-
- start_time - -
- string -
- 		- -
Specify start time for file transmission (yyyy-mm-dd.hh:mm).
-
-
- transfer_interval - -
- integer -
- 		- -
Specify frequency at which to transfer files to archive sites (5..2880 minutes).
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- authorization - -
- dictionary -
- 		- -
Specify authorization system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- change_log - -
- dictionary -
- 		- -
Specify configuration change log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- conflict_log - -
- dictionary -
- 		- -
Specify configuration conflict log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- daemon - -
- dictionary -
- 		- -
Specify various system processes.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- dfc - -
- dictionary -
- 		- -
Specify dynamic flow capture.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- explicit_priority - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include priority and facility in messages.
-
-
- external - -
- dictionary -
- 		- -
Specify Local external applications.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- firewall - -
- dictionary -
- 		- -
Specify Firewall filtering system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- ftp - -
- dictionary -
- 		- -
Specify FTP process.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- interactive_commands - -
- dictionary -
- 		- -
Specify commands executed by the UI.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- kernel - -
- dictionary -
- 		- -
Specify Kernel specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- match - -
- string -
- 		- -
Specify regular expression for lines to be logged.
-
-
- match_strings - -
- list - / elements=string -
- 		- -
Specify matching string(s) for lines to be logged.
-
-
- name - -
- string -
- 		- -
Specify filename in which to log data.
-
-
- ntp - -
- dictionary -
- 		- -
Specify NTP process specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- pfe - -
- dictionary -
- 		- -
Specify Packet Forwarding Engine specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- security - -
- dictionary -
- 		- -
Specify Security related logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- structured_data - -
- dictionary -
- 		- -
Specify Log system message in structured format.
-
-
- brief - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Omit English-language text from end of logged messages.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Log system message in structured format.
-
-
- user - -
- dictionary -
- 		- -
Specify user specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- hosts - -
- list - / elements=dictionary -
- 		- -
Specify hosts to be notified.
-
-
- allow_duplicates - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not suppress the repeated message for all targets.
-
-
- any - -
- dictionary -
- 		- -
Set All facilities.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- authorization - -
- dictionary -
- 		- -
Specify authorization system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- change_log - -
- dictionary -
- 		- -
Specify configuration change log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- conflict_log - -
- dictionary -
- 		- -
Specify configuration conflict log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- daemon - -
- dictionary -
- 		- -
Specify various system processes.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- dfc - -
- dictionary -
- 		- -
Specify dynamic flow capture.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- exclude_hostname - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify exclude hostname field in messages.
-
-
- explicit_priority - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include priority and facility in messages.
-
-
- external - -
- dictionary -
- 		- -
Specify Local external applications.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- facility_override - -
- string -
- 		- -
Specify alternate facility for logging to remote host.
-
-
- firewall - -
- dictionary -
- 		- -
Specify Firewall filtering system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- ftp - -
- dictionary -
- 		- -
Specify FTP process.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- interactive_commands - -
- dictionary -
- 		- -
Specify commands executed by the UI.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- kernel - -
- dictionary -
- 		- -
Specify Kernel specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- log_prefix - -
- string -
- 		- -
Prefix for all logging to this host.
-
-
- match - -
- string -
- 		- -
Specify regular expression for lines to be logged.
-
-
- match_strings - -
- list - / elements=string -
- 		- -
Specify matching string(s) for lines to be logged.
-
-
- name - -
- string -
- 		- -
Specify the host name.
-
-
- ntp - -
- dictionary -
- 		- -
Specify NTP process specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- pfe - -
- dictionary -
- 		- -
Specify Packet Forwarding Engine specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- port - -
- integer -
- 		- -
Specify port number.
-
-
- routing_instance - -
- string -
- 		- -
Specify routing-instance.
-
-
- security - -
- dictionary -
- 		- -
Specify Security related logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- source_address - -
- string -
- 		- -
Specify address as source address.
-
-
- structured_data - -
- dictionary -
- 		- -
Specify Log system message in structured format.
-
-
- brief - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Omit English-language text from end of logged messages.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Log system message in structured format.
-
-
- user - -
- dictionary -
- 		- -
Specify user specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- log_rotate_frequency - -
- integer -
- 		- -
Specify Rotate log frequency (1..59 minutes).
-
-
- routing_instance - -
- string -
- 		- -
Specify Routing routing-instance.
-
-
- server - -
- dictionary -
- 		- -
Specify syslog server logging.
-
-
- routing_instance - -
- dictionary -
- 		- -
nable/disable syslog server in routing-instances.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable all routing instances.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable default routing instances.
-
-
- routing_instances - -
- list - / elements=dictionary -
- 		- -
Specify routing-instances.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable syslog server in this routing instances.
-
-
- name - -
- string -
- 		- -
Specify routing-instance name.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable syslog server.
-
-
- source_address - -
- string -
- 		- -
Specify address as source address.
-
-
- time_format - -
- dictionary -
- 		- -
Specify additional information to include in system log timestamp.
-
-
- millisecond - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include milliseconds in timestamp.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set time-format
-
-
- year - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include year in timestamp.
-
-
- users - -
- list - / elements=dictionary -
- 		- -
Specify user logging
-
-
- allow_duplicates - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not suppress the repeated message for all targets.
-
-
- any - -
- dictionary -
- 		- -
Set All facilities.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- authorization - -
- dictionary -
- 		- -
Specify authorization system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- change_log - -
- dictionary -
- 		- -
Specify configuration change log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- conflict_log - -
- dictionary -
- 		- -
Specify configuration conflict log.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- daemon - -
- dictionary -
- 		- -
Specify various system processes.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- dfc - -
- dictionary -
- 		- -
Specify dynamic flow capture.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- external - -
- dictionary -
- 		- -
Specify Local external applications.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- firewall - -
- dictionary -
- 		- -
Specify Firewall filtering system.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- ftp - -
- dictionary -
- 		- -
Specify FTP process.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- interactive_commands - -
- dictionary -
- 		- -
Specify commands executed by the UI.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- kernel - -
- dictionary -
- 		- -
Specify Kernel specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- match - -
- string -
- 		- -
Specify regular expression for lines to be logged.
-
-
- match_strings - -
- list - / elements=string -
- 		- -
Specify matching string(s) for lines to be logged.
-
-
- name - -
- string -
- 		- -
Specify user name.
-
-
- ntp - -
- dictionary -
- 		- -
Specify NTP process specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- pfe - -
- dictionary -
- 		- -
Specify Packet Forwarding Engine specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- security - -
- dictionary -
- 		- -
Specify Security related logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- user - -
- dictionary -
- 		- -
Specify user specific logging.
-
-
- level - -
- string - / required -
- 		-
    Choices: -
  • alert
    • -
  • any
    • -
  • critical
    • -
  • emergency
    • -
  • error
    • -
  • info
    • -
  • none
    • -
  • notice
    • -
  • warning
    • -
- 		-
Set severity logging level.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show system syslog.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • overridden
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. - - See `the Junos OS Platform Options `_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state - # ------------ - # - # vagrant@vsrx# show system syslog - # - # [edit] - # vagrant@vsrx# show routing-instances - # inst11 { - # description inst11; - # } - - name: Merge provided logging configuration into running configuration. - junipernetworks.junos.junos_logging_global: - config: - allow_duplicates: true - archive: - set: true - no_binary_data: true - files: 10 - file_size: 65578 - no_world_readable: true - console: - any: - level: "info" - authorization: - level: "any" - change_log: - level: "critical" - ftp: - level: "none" - files: - - name: "file101" - allow_duplicates: true - - name: "file102" - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - - name: "file103" - archive: - set: true - no_binary_data: true - files: 10 - file_size: 65578 - no_world_readable: true - explicit_priority: true - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - hosts: - - name: host111 - exclude_hostname: true - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - brief: true - facility_override: "ftp" - log_prefix: "field" - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - port: 1231 - routing_instance: "inst11" - source_address: "11.1.1.11" - routing_instance: "inst11" - log_rotate_frequency: 45 - source_address: "33.33.33.33" - time_format: - millisecond: true - year: true - users: - - name: "user1" - allow_duplicates: true - - name: "user2" - allow_duplicates: true - any: - level: "any" - user: - level: info - state: merged - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "allow_duplicates": true, - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "console": { - # "any": { - # "level": "info" - # }, - # "authorization": { - # "level": "any" - # }, - # "change_log": { - # "level": "critical" - # }, - # "ftp": { - # "level": "none" - # } - # }, - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file101" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # }, - # { - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "explicit_priority": true, - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "file103" - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host111", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "log_rotate_frequency": 45, - # "routing_instance": "inst11", - # "source_address": "33.33.33.33", - # "time_format": { - # "millisecond": true, - # "year": true - # }, - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "before": {}, - # "changed": true, - # "commands": [ - # "" - # "10" - # "65578" - # "change-log" - # "anyauthorization" - # "ftp" - # "file101file102" - # "any" - # "file10310" - # "65578" - # "^set*^delete" - # "^prompthost111" - # "any" - # "ftp" - # "field^set*^delete" - # "^prompt1231" - # "inst1111.1.1.11" - # "" - # "45inst11" - # "33.33.33.33" - # "user1" - # "user2any" - # "user" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system syslog - # archive size 65578 files 10 no-world-readable no-binary-data; - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host111 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # allow-duplicates; - # file file101 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - # file file103 { - # match "^set*"; - # archive size 65578 files 10 no-world-readable no-binary-data; - # explicit-priority; - # match-strings [ "^delete" "^prompt" ]; - # } - # console { - # any info; - # authorization any; - # ftp none; - # change-log critical; - # } - # time-format year millisecond; - # source-address 33.33.33.33; - # routing-instance inst11; - # log-rotate-frequency 45; - # Using replaced - # - # Before state - # ------------ - # - # vagrant@vsrx# show system syslog - # archive size 65578 files 10 no-world-readable no-binary-data; - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host111 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # allow-duplicates; - # file file101 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - # file file103 { - # match "^set*"; - # archive size 65578 files 10 no-world-readable no-binary-data; - # explicit-priority; - # match-strings [ "^delete" "^prompt" ]; - # } - # console { - # any info; - # authorization any; - # ftp none; - # change-log critical; - # } - # time-format year millisecond; - # source-address 33.33.33.33; - # routing-instance inst11; - # log-rotate-frequency 45; - - name: Replaced running logging global configuration with provided configuration - junipernetworks.junos.junos_logging_global: - config: - files: - - name: "file104" - allow_duplicates: true - - name: "file102" - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - hosts: - - name: host222 - exclude_hostname: true - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - brief: true - facility_override: "ftp" - log_prefix: "field" - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - port: 1231 - routing_instance: "inst11" - source_address: "11.1.1.11" - users: - - name: "user1" - allow_duplicates: true - - name: "user2" - allow_duplicates: true - any: - level: "any" - user: - level: info - state: replaced - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file104" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host222", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "before": { - # "allow_duplicates": true, - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "console": { - # "any": { - # "level": "info" - # }, - # "authorization": { - # "level": "any" - # }, - # "change_log": { - # "level": "critical" - # }, - # "ftp": { - # "level": "none" - # } - # }, - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file101" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # }, - # { - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "explicit_priority": true, - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "file103" - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host111", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "log_rotate_frequency": 45, - # "routing_instance": "inst11", - # "source_address": "33.33.33.33", - # "time_format": { - # "millisecond": true, - # "year": true - # }, - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "changed": true, - # "commands": [ - # "" - # "file104" - # "file102" - # "any" - # "host222any" - # "ftp" - # "field^set*" - # "^delete" - # "^prompt1231" - # "inst1111.1.1.11" - # "user1" - # "user2" - # "any" - # "user" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system syslog - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host222 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # file file104 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - # Using overridden - # - # Before state - # ------------ - # - # vagrant@vsrx# show system syslog - # archive size 65578 files 10 no-world-readable no-binary-data; - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host111 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # allow-duplicates; - # file file101 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - # file file103 { - # match "^set*"; - # archive size 65578 files 10 no-world-readable no-binary-data; - # explicit-priority; - # match-strings [ "^delete" "^prompt" ]; - # } - # console { - # any info; - # authorization any; - # ftp none; - # change-log critical; - # } - # time-format year millisecond; - # source-address 33.33.33.33; - # routing-instance inst11; - # log-rotate-frequency 45; - - name: Override running logging global configuration with provided configuration - junipernetworks.junos.junos_logging_global: - config: - files: - - name: "file104" - allow_duplicates: true - - name: "file102" - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - hosts: - - name: host222 - exclude_hostname: true - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - brief: true - facility_override: "ftp" - log_prefix: "field" - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - port: 1231 - routing_instance: "inst11" - source_address: "11.1.1.11" - users: - - name: "user1" - allow_duplicates: true - - name: "user2" - allow_duplicates: true - any: - level: "any" - user: - level: info - state: overridden - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file104" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host222", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "before": { - # "allow_duplicates": true, - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "console": { - # "any": { - # "level": "info" - # }, - # "authorization": { - # "level": "any" - # }, - # "change_log": { - # "level": "critical" - # }, - # "ftp": { - # "level": "none" - # } - # }, - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file101" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # }, - # { - # "archive": { - # "file_size": 65578, - # "files": 10, - # "no_binary_data": true, - # "no_world_readable": true - # }, - # "explicit_priority": true, - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "file103" - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host111", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "log_rotate_frequency": 45, - # "routing_instance": "inst11", - # "source_address": "33.33.33.33", - # "time_format": { - # "millisecond": true, - # "year": true - # }, - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "changed": true, - # "commands": [ - # "" - # "file104" - # "file102" - # "any" - # "host222any" - # "ftp" - # "field^set*" - # "^delete" - # "^prompt1231" - # "inst1111.1.1.11" - # "user1" - # "user2" - # "any" - # "user" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system syslog - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host222 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # file file104 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - # Using deleted - # - # Before state - # ------------ - # - # vagrant@vsrx# show system syslog - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host222 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # file file104 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - - name: Delete running logging global configuration - junipernetworks.junos.junos_logging_global: - config: - state: deleted - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": {}, - # "before": { - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file104" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host222", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "changed": true, - # "commands": [ - # "" - # "" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system syslog - # - # [edit] - # Using gathered - # - # Before state - # ------------ - # - # vagrant@vsrx# show system syslog - # user user1 { - # allow-duplicates; - # } - # user user2 { - # any any; - # user info; - # allow-duplicates; - # } - # host host222 { - # any any; - # match "^set*"; - # allow-duplicates; - # port 1231; - # facility-override ftp; - # log-prefix field; - # source-address 11.1.1.11; - # routing-instance inst11; - # exclude-hostname; - # match-strings [ "^delete" "^prompt" ]; - # structured-data { - # brief; - # } - # } - # file file104 { - # allow-duplicates; - # } - # file file102 { - # any any; - # allow-duplicates; - # structured-data; - # } - - name: Gather running logging global configuration - junipernetworks.junos.junos_logging_global: - state: gathered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "gathered": { - # "files": [ - # { - # "allow_duplicates": true, - # "name": "file104" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "file102", - # "structured_data": { - # "set": true - # } - # } - # ], - # "hosts": [ - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "exclude_hostname": true, - # "facility_override": "ftp", - # "log_prefix": "field", - # "match": "^set*", - # "match_strings": [ - # "^delete", - # "^prompt" - # ], - # "name": "host222", - # "port": 1231, - # "routing_instance": "inst11", - # "source_address": "11.1.1.11", - # "structured_data": { - # "brief": true - # } - # } - # ], - # "users": [ - # { - # "allow_duplicates": true, - # "name": "user1" - # }, - # { - # "allow_duplicates": true, - # "any": { - # "level": "any" - # }, - # "name": "user2", - # "user": { - # "level": "info" - # } - # } - # ] - # }, - # "changed": false, - # Using rendered - # - # Before state - # ------------ - # - - name: Render xml for provided facts. - junipernetworks.junos.junos_logging_global: - config: - allow_duplicates: true - archive: - set: true - no_binary_data: true - files: 10 - file_size: 65578 - no_world_readable: true - console: - any: - level: "info" - authorization: - level: "any" - change_log: - level: "critical" - ftp: - level: "none" - files: - - name: "file101" - allow_duplicates: true - - name: "file102" - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - - name: "file103" - archive: - set: true - no_binary_data: true - files: 10 - file_size: 65578 - no_world_readable: true - explicit_priority: true - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - hosts: - - name: host111 - exclude_hostname: true - allow_duplicates: true - any: - level: "any" - structured_data: - set: true - brief: true - facility_override: "ftp" - log_prefix: "field" - match: "^set*" - match_strings: - - "^delete" - - "^prompt" - port: 1231 - routing_instance: "inst11" - source_address: "11.1.1.11" - routing_instance: "inst11" - log_rotate_frequency: 45 - source_address: "33.33.33.33" - time_format: - millisecond: true - year: true - users: - - name: "user1" - allow_duplicates: true - - name: "user2" - allow_duplicates: true - any: - level: "any" - user: - level: info - state: rendered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "rendered": [ - # "" - # "10" - # "65578" - # "change-log" - # "anyauthorization" - # "ftp" - # "file101file102" - # "any" - # "file10310" - # "65578" - # "^set*^delete" - # "^prompthost111" - # "any" - # "ftp" - # "field^set*^delete" - # "^prompt1231" - # "inst1111.1.1.11" - # "" - # "45inst11" - # "33.33.33.33" - # "user1" - # "user2any" - # "user" - # ] - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # - # * - # - # any - # - # - # - # - # messages - # - # any - # - # - # - # authorization - # - # - # - # - # interactive-commands - # - # interactive-commands - # - # - # - # - # - # - # - - name: Parse logging global running config - junipernetworks.junos.junos_routing_instances: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - # - # - # ------------------------- - # Module Execution Result - # ------------------------- - # - # - # "parsed": { - # "files": [ - # { - # "any": { - # "level": "any" - # }, - # "authorization": { - # "level": "info" - # }, - # "name": "messages" - # }, - # { - # "interactive_commands": { - # "level": "any" - # }, - # "name": "interactive-commands" - # } - # ], - # "users": [ - # { - # "any": { - # "level": "emergency" - # }, - # "name": "*" - # } - # ] - # } - # - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:allow-duplicates/></nc:user><nc:user><nc:name>user2</nc:name> <nc:allow-duplicates/><nc:contents><nc:name>any</nc:name><nc:any/> </nc:contents><nc:contents><nc:name>user</nc:name><nc:info/></nc:contents> </nc:user></nc:syslog></nc:system>"', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_ntp_global_module.rst b/docs/junipernetworks.junos.junos_ntp_global_module.rst deleted file mode 100644 index 0aaeb963..00000000 --- a/docs/junipernetworks.junos.junos_ntp_global_module.rst +++ /dev/null @@ -1,1551 +0,0 @@ -.. _junipernetworks.junos.junos_ntp_global_module: - - -************************************** -junipernetworks.junos.junos_ntp_global -************************************** - -**Manage NTP configuration on Junos devices.** - - -Version added: 2.6.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages NTP configuration on devices running Junos. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of NTP configuration.
-
-
- authentication_keys - -
- list - / elements=dictionary -
- 		- -
NTP authentication key.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha1
    • -
  • sha256
    • -
- 		-
Authentication key type.
-
-
- id - -
- integer -
- 		- -
Authentication key number.
-
-
- key - -
- string -
- 		- -
Authentication key value.
-
-
- boot_server - -
- string -
- 		- -
Server to query during boot sequence.
-
-
- broadcast_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Listen to broadcast NTP.
-
-
- broadcasts - -
- list - / elements=dictionary -
- 		- -
Broadcast parameters.
-
-
- address - -
- string -
- 		- -
Broadcast or multicast address to use.
-
-
- key - -
- string -
- 		- -
Authentication key.
-
-
- routing_instance_name - -
- string -
- 		- -
Routing intance name in which interface has address in broadcast subnet.
-
-
- ttl - -
- integer -
- 		- -
TTL value to transmit.
-
-
- version - -
- integer -
- 		- -
NTP version to use.
-
-
- interval_range - -
- integer -
- 		- -
Set the minpoll and maxpoll interval range.
-
-
- multicast_client - -
- string -
- 		- -
Listen to multicast NTP address.
-
-
- peers - -
- list - / elements=dictionary -
- 		- -
NTP Peers.
-
-
- key_id - -
- integer -
- 		- -
Key-id to be used while communicating.
-
-
- peer - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prefer this peer.
-
-
- version - -
- integer -
- 		- -
NTP version to use.
-
-
- servers - -
- list - / elements=dictionary -
- 		- -
NTP Servers.
-
-
- key_id - -
- integer -
- 		- -
Key-id to be used while communicating.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prefer this peer_serv.
-
-
- routing_instance - -
- string -
- 		- -
Routing instance through which server is reachable.
-
-
- server - -
- string -
- 		- -
IP address or hostname of the server.
-
-
- version - -
- integer -
- 		- -
NTP version to use.
-
-
- source_addresses - -
- list - / elements=dictionary -
- 		- -
Source-Address parameters.
-
-
- routing_instance - -
- string -
- 		- -
Routing intance name in which source address is defined.
-
-
- source_address - -
- string -
- 		- -
Use specified address as source address.
-
-
- threshold - -
- dictionary -
- 		- -
Set the maximum threshold(sec) allowed for NTP adjustment.
-
-
- action - -
- string -
- 		-
    Choices: -
  • accept
    • -
  • reject
    • -
- 		-
Select actions for NTP abnormal adjustment.
-
-
- value - -
- integer -
- 		- -
The maximum value(sec) allowed for NTP adjustment.
-
-
- trusted_keys - -
- list - / elements=dictionary -
- 		- -
List of trusted authentication keys.
-
-
- key_id - -
- integer -
- 		- -
Trusted-Key number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show system syslog.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • overridden
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. - - See `the Junos OS Platform Options `_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state - # ------------ - # - # vagrant@vsrx# show system ntp - # - # [edit] - # vagrant@vsrx# show routing-instances - # rt1 { - # description rt1; - # } - # rt2 { - - name: Merge provided NTP configuration into running configuration. - junipernetworks.junos.junos_ntp_global: - config: - boot_server: '78.46.194.186' - broadcasts: - - address: '172.16.255.255' - key: '50' - ttl: 200 - version: 3 - routing_instance_name: 'rt1' - - address: '192.16.255.255' - key: '50' - ttl: 200 - version: 3 - routing_instance_name: 'rt2' - broadcast_client: true - interval_range: 2 - multicast_client: "224.0.0.1" - peers: - - peer: "78.44.194.186" - - peer: "172.44.194.186" - key_id: 10000 - prefer: true - version: 3 - servers: - - server: "48.46.194.186" - key_id: 34 - prefer: true - version: 2 - routing_instance: 'rt1' - - server: "48.45.194.186" - key_id: 34 - prefer: true - version: 2 - source_addresses: - - source_address: "172.45.194.186" - routing_instance: 'rt1' - - source_address: "171.45.194.186" - routing_instance: 'rt2' - threshold: - value: 300 - action: "accept" - trusted_keys: - - key_id: 3000 - - key_id: 2000 - state: merged - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "boot_server": "78.46.194.186", - # "broadcast_client": true, - # "broadcasts": [ - # { - # "address": "172.16.255.255", - # "key": "50", - # "routing_instance_name": "rt1", - # "ttl": 200, - # "version": 3 - # }, - # { - # "address": "192.16.255.255", - # "key": "50", - # "routing_instance_name": "rt2", - # "ttl": 200, - # "version": 3 - # } - # ], - # "interval_range": 2, - # "multicast_client": "224.0.0.1", - # "peers": [ - # { - # "peer": "78.44.194.186" - # }, - # { - # "key_id": 10000, - # "peer": "172.44.194.186", - # "prefer": true, - # "version": 3 - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ], - # "source_addresses": [ - # { - # "routing_instance": "rt1", - # "source_address": "172.45.194.186" - # }, - # { - # "routing_instance": "rt2", - # "source_address": "171.45.194.186" - # } - # ], - # "threshold": { - # "action": "accept", - # "value": 300 - # }, - # "trusted_keys": [ - # {"key_id": 2000}, - # {"key_id": 3000} - # ] - # }, - # "before": {}, - # "changed": true, - # "commands": [ - # "" - # "78.46.194.186" - # "172.16.255.25550rt1" - # "2003192.16.255.255" - # "50rt2200" - # "32" - # "224.0.0.178.44.194.186" - # "172.44.194.186100003" - # "48.46.194.18634rt1" - # "248.45.194.18634" - # "2172.45.194.186" - # "rt1" - # "171.45.194.186rt2" - # "300accept" - # "30002000" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system ntp - # boot-server 78.46.194.186; - # interval-range 2; - # peer 78.44.194.186; - # peer 172.44.194.186 key 10000 version 3 prefer; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # broadcast 172.16.255.255 routing-instance-name rt1 key 50 version 3 ttl 200; - # broadcast 192.16.255.255 routing-instance-name rt2 key 50 version 3 ttl 200; - # broadcast-client; - # multicast-client 224.0.0.1; - # trusted-key [ 3000 2000 ]; - # threshold 300 action accept; - # source-address 172.45.194.186 routing-instance rt1; - # source-address 171.45.194.186 routing-instance rt2; - # - # - # Using Replaced - # Before state - # ------------ - # - # vagrant@vsrx# show system ntp - # boot-server 78.46.194.186; - # interval-range 2; - # peer 78.44.194.186; - # peer 172.44.194.186 key 10000 version 3 prefer; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # broadcast 172.16.255.255 routing-instance-name rt1 key 50 version 3 ttl 200; - # broadcast 192.16.255.255 routing-instance-name rt2 key 50 version 3 ttl 200; - # broadcast-client; - # multicast-client 224.0.0.1; - # trusted-key [ 3000 2000 ]; - # threshold 300 action accept; - # source-address 172.45.194.186 routing-instance rt1; - # source-address 171.45.194.186 routing-instance rt2; - - - name: Replaced running ntp global configuration with provided configuration - junipernetworks.junos.junos_ntp_global: - config: - authentication_keys: - - id: 2 - algorithm: 'md5' - key: 'asdfghd' - - id: 5 - algorithm: 'sha1' - key: 'aasdad' - servers: - - server: "48.46.194.186" - key_id: 34 - prefer: true - version: 2 - routing_instance: 'rt1' - - server: "48.45.194.186" - key_id: 34 - prefer: true - version: 2 - state: replaced - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "authentication_keys": [ - # { - # "algorithm": "md5", - # "id": 2, - # "key": "$9$03aAB1hreW7NbO1rvMLVbgoJ" - # }, - # { - # "algorithm": "sha1", - # "id": 5, - # "key": "$9$DXiHmf5F/A0ZUjq.P3n" - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ] - # }, - # "before": { - # "boot_server": "78.46.194.186", - # "broadcast_client": true, - # "broadcasts": [ - # { - # "address": "172.16.255.255", - # "key": "50", - # "routing_instance_name": "rt1", - # "ttl": 200, - # "version": 3 - # }, - # { - # "address": "192.16.255.255", - # "key": "50", - # "routing_instance_name": "rt2", - # "ttl": 200, - # "version": 3 - # } - # ], - # "interval_range": 2, - # "multicast_client": "224.0.0.1", - # "peers": [ - # { - # "peer": "78.44.194.186" - # }, - # { - # "key_id": 10000, - # "peer": "172.44.194.186", - # "prefer": true, - # "version": 3 - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ], - # "source_addresses": [ - # { - # "routing_instance": "rt1", - # "source_address": "172.45.194.186" - # }, - # { - # "routing_instance": "rt2", - # "source_address": "171.45.194.186" - # } - # ], - # "threshold": { - # "action": "accept", - # "value": 300 - # }, - # "trusted_keys": [ - # {"key_id": 2000}, - # {"key_id": 3000} - # ] - # }, - # "changed": true, - # "commands": [ - # " - # "2md5 - # "asdfghd5 - # "sha1aasdad - # "48.46.194.18634rt1 - # "248.45.194.186 - # "342" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system ntp - # authentication-key 2 type md5 value "$9$03aAB1hreW7NbO1rvMLVbgoJ"; ## SECRET-DATA - # authentication-key 5 type sha1 value "$9$DXiHmf5F/A0ZUjq.P3n"; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - - # Using overridden - # - # Before state - # ------------ - # - # vagrant@vsrx# show system ntp - # boot-server 78.46.194.186; - # interval-range 2; - # peer 78.44.194.186; - # peer 172.44.194.186 key 10000 version 3 prefer; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # broadcast 172.16.255.255 routing-instance-name rt1 key 50 version 3 ttl 200; - # broadcast 192.16.255.255 routing-instance-name rt2 key 50 version 3 ttl 200; - # broadcast-client; - # multicast-client 224.0.0.1; - # trusted-key [ 3000 2000 ]; - # threshold 300 action accept; - # source-address 172.45.194.186 routing-instance rt1; - # source-address 171.45.194.186 routing-instance rt2; - - - name: Override running ntp global configuration with provided configuration - junipernetworks.junos.junos_ntp_global: - config: - authentication_keys: - - id: 2 - algorithm: 'md5' - key: 'asdfghd' - - id: 5 - algorithm: 'sha1' - key: 'aasdad' - servers: - - server: "48.46.194.186" - key_id: 34 - prefer: true - version: 2 - routing_instance: 'rt1' - - server: "48.45.194.186" - key_id: 34 - prefer: true - version: 2 - state: overridden - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "authentication_keys": [ - # { - # "algorithm": "md5", - # "id": 2, - # "key": "$9$03aAB1hreW7NbO1rvMLVbgoJ" - # }, - # { - # "algorithm": "sha1", - # "id": 5, - # "key": "$9$DXiHmf5F/A0ZUjq.P3n" - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ] - # }, - # "before": { - # "boot_server": "78.46.194.186", - # "broadcast_client": true, - # "broadcasts": [ - # { - # "address": "172.16.255.255", - # "key": "50", - # "routing_instance_name": "rt1", - # "ttl": 200, - # "version": 3 - # }, - # { - # "address": "192.16.255.255", - # "key": "50", - # "routing_instance_name": "rt2", - # "ttl": 200, - # "version": 3 - # } - # ], - # "interval_range": 2, - # "multicast_client": "224.0.0.1", - # "peers": [ - # { - # "peer": "78.44.194.186" - # }, - # { - # "key_id": 10000, - # "peer": "172.44.194.186", - # "prefer": true, - # "version": 3 - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ], - # "source_addresses": [ - # { - # "routing_instance": "rt1", - # "source_address": "172.45.194.186" - # }, - # { - # "routing_instance": "rt2", - # "source_address": "171.45.194.186" - # } - # ], - # "threshold": { - # "action": "accept", - # "value": 300 - # }, - # "trusted_keys": [ - # {"key_id": 2000}, - # {"key_id": 3000} - # ] - # }, - # "changed": true, - # "commands": [ - # " - # "2md5 - # "asdfghd5 - # "sha1aasdad - # "48.46.194.18634rt1 - # "248.45.194.186 - # "342" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system ntp - # authentication-key 2 type md5 value "$9$03aAB1hreW7NbO1rvMLVbgoJ"; ## SECRET-DATA - # authentication-key 5 type sha1 value "$9$DXiHmf5F/A0ZUjq.P3n"; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # - # Using deleted - # - # Before state - # ------------ - # - # vagrant@vsrx# show system ntp - # authentication-key 2 type md5 value "$9$03aAB1hreW7NbO1rvMLVbgoJ"; ## SECRET-DATA - # authentication-key 5 type sha1 value "$9$DXiHmf5F/A0ZUjq.P3n"; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # - - name: Delete running NTP global configuration - junipernetworks.junos.junos_ntp_global: - config: - state: deleted - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": {}, - # "before": { - # "authentication_keys": [ - # { - # "algorithm": "md5", - # "id": 2, - # "key": "$9$03aAB1hreW7NbO1rvMLVbgoJ" - # }, - # { - # "algorithm": "sha1", - # "id": 5, - # "key": "$9$DXiHmf5F/A0ZUjq.P3n" - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ] - # }, - # "changed": true, - # "commands": [ - # "" - # "" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show system ntp - # - # [edit] - # Using gathered - # - # Before state - # ------------ - # - # vagrant@vsrx# show system ntp - # boot-server 78.46.194.186; - # interval-range 2; - # peer 78.44.194.186; - # peer 172.44.194.186 key 10000 version 3 prefer; ## SECRET-DATA - # server 48.46.194.186 key 34 version 2 prefer routing-instance rt1; ## SECRET-DATA - # server 48.45.194.186 key 34 version 2 prefer; ## SECRET-DATA - # broadcast 172.16.255.255 routing-instance-name rt1 key 50 version 3 ttl 200; - # broadcast 192.16.255.255 routing-instance-name rt2 key 50 version 3 ttl 200; - # broadcast-client; - # multicast-client 224.0.0.1; - # trusted-key [ 3000 2000 ]; - # threshold 300 action accept; - # source-address 172.45.194.186 routing-instance rt1; - # source-address 171.45.194.186 routing-instance rt2; - - name: Gather running NTP global configuration - junipernetworks.junos.junos_ntp_global: - state: gathered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "gathered": { - # "boot_server": "78.46.194.186", - # "broadcast_client": true, - # "broadcasts": [ - # { - # "address": "172.16.255.255", - # "key": "50", - # "routing_instance_name": "rt1", - # "ttl": 200, - # "version": 3 - # }, - # { - # "address": "192.16.255.255", - # "key": "50", - # "routing_instance_name": "rt2", - # "ttl": 200, - # "version": 3 - # } - # ], - # "interval_range": 2, - # "multicast_client": "224.0.0.1", - # "peers": [ - # { - # "peer": "78.44.194.186" - # }, - # { - # "key_id": 10000, - # "peer": "172.44.194.186", - # "prefer": true, - # "version": 3 - # } - # ], - # "servers": [ - # { - # "key_id": 34, - # "prefer": true, - # "routing_instance": "rt1", - # "server": "48.46.194.186", - # "version": 2 - # }, - # { - # "key_id": 34, - # "prefer": true, - # "server": "48.45.194.186", - # "version": 2 - # } - # ], - # "source_addresses": [ - # { - # "routing_instance": "rt1", - # "source_address": "172.45.194.186" - # }, - # { - # "routing_instance": "rt2", - # "source_address": "171.45.194.186" - # } - # ], - # "threshold": { - # "action": "accept", - # "value": 300 - # }, - # "trusted_keys": [ - # {"key_id": 2000}, - # {"key_id": 3000} - # ] - # }, - # "changed": false, - # Using rendered - # - # Before state - # ------------ - # - - name: Render xml for provided facts. - junipernetworks.junos.junos_ntp_global: - config: - boot_server: '78.46.194.186' - broadcasts: - - address: '172.16.255.255' - key: '50' - ttl: 200 - version: 3 - routing_instance_name: 'rt1' - - address: '192.16.255.255' - key: '50' - ttl: 200 - version: 3 - routing_instance_name: 'rt2' - broadcast_client: true - interval_range: 2 - multicast_client: "224.0.0.1" - peers: - - peer: "78.44.194.186" - - peer: "172.44.194.186" - key_id: 10000 - prefer: true - version: 3 - servers: - - server: "48.46.194.186" - key_id: 34 - prefer: true - version: 2 - routing_instance: 'rt1' - - server: "48.45.194.186" - key_id: 34 - prefer: true - version: 2 - source_addresses: - - source_address: "172.45.194.186" - routing_instance: 'rt1' - - source_address: "171.45.194.186" - routing_instance: 'rt2' - threshold: - value: 300 - action: "accept" - trusted_keys: - - 3000 - - 2000 - state: rendered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "rendered": [ - # "" - # "78.46.194.186172.16.255.255" - # "50rt1200" - # "3192.16.255.255" - # "50rt2" - # "2003" - # "2224.0.0.1" - # "78.44.194.186172.44.194.186" - # "100003" - # "48.46.194.18634rt1" - # "248.45.194.186" - # "342" - # "172.45.194.186rt1" - # "171.45.194.186rt2" - # "300accept" - # "30002000" - # ] - # - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # - # 2 - # md5 - # $9$GxDjqfT3CA0UjfzF6u0RhS - # - # - # 5 - # sha1 - # $9$ZsUDk.mT3/toJGiHqQz - # - # - # - # - # - # - - name: Parse NTP global running config - junipernetworks.junos.junos_ntp_global: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - # - # - # ------------------------- - # Module Execution Result - # ------------------------- - # - # - # "parsed": { - # "authentication_keys": [ - # { - # "algorithm": "md5", - # "id": 2, - # "key": "$9$GxDjqfT3CA0UjfzF6u0RhS" - # }, - # { - # "algorithm": "sha1", - # "id": 5, - # "key": "$9$ZsUDk.mT3/toJGiHqQz" - # } - # ] - # } - # - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:name>78.44.194.186</nc:name></nc:peer><nc:peer><nc:name>172.44.194.186</nc:name>', 'xml 2', 'xml 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_ospfv2_module.rst b/docs/junipernetworks.junos.junos_ospfv2_module.rst deleted file mode 100644 index 18e04ea6..00000000 --- a/docs/junipernetworks.junos.junos_ospfv2_module.rst +++ /dev/null @@ -1,1995 +0,0 @@ -.. _junipernetworks.junos.junos_ospfv2_module: - - -********************************** -junipernetworks.junos.junos_ospfv2 -********************************** - -**OSPFv2 resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPFv2 configuration on devices running Juniper JUNOS. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of OSPFv2 process configuration.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
A list of OSPFv2 areas' configuration.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID as an integer or IP Address.
-
-
- area_range - -
- string -
- 		- -
Configure an address range for the area.
-
Included for compatibility, remove/deprecate after 2025-07-01.
-
Alternate for this would be area_ranges which is a list.
-
-
- area_ranges - -
- list - / elements=dictionary -
- 		- -
Configure IP address ranges for the area.
-
-
- address - -
- string -
- 		- -
Specify ip address.
-
-
- exact - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce exact match for advertisement of this area range.
-
-
- override_metric - -
- integer -
- 		- -
Override the dynamic metric for this area-range.
-
-
- restrict - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Restrict advertisement of this area range.
-
-
- interfaces - -
- list - / elements=dictionary -
- 		- -
List of interfaces in this area.
-
-
- authentication - -
- dictionary -
- 		- -
Specify authentication type
-
-
- md5 - -
- list - / elements=dictionary -
- 		- -
MD5 authentication keys
-
-
- key - -
- string -
- 		- -
Specify key value
-
-
- key_id - -
- integer -
- 		- -
Specify the key identity
-
-
- start_time - -
- string -
- 		- -
Specify Start time for key transmission (YYYY-MM-DD.HH:MM)
-
-
- password - -
- string -
- 		- -
Specify authentication key.
-
-
- type - -
- dictionary -
- 		- -
Type of authentication to use.
-
Included for compatibility, remove/deprecate after 2025-07-01.
-
-
- bandwidth_based_metrics - -
- list - / elements=dictionary -
- 		- -
Specify list of bandwidth based metrics
-
-
- bandwidth - -
- string -
- 		-
    Choices: -
  • 1g
    • -
  • 10g
    • -
- 		-
BW to apply metric to.
-
-
- metric - -
- integer -
- 		- -
Specify metric
-
-
- flood_reduction - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable flood reduction.
-
-
- metric - -
- integer -
- 		- -
Metric applied to the interface.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify passive
-
-
- priority - -
- integer -
- 		- -
Priority for the interface.
-
-
- timers - -
- dictionary -
- 		- -
Specify timers
-
-
- dead_interval - -
- integer -
- 		- -
Dead interval (seconds).
-
-
- hello_interval - -
- integer -
- 		- -
Hello interval (seconds).
-
-
- poll_interval - -
- integer -
- 		- -
Poll interval (seconds).
-
-
- retransmit_interval - -
- integer -
- 		- -
Retransmit interval (seconds).
-
-
- transit_delay - -
- integer -
- 		- -
Transit delay (seconds).
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- default_metric - -
- integer -
- 		- -
Metric for the default route in this area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- external_preference - -
- integer -
- 		- -
Preference of external routes.
-
-
- overload - -
- dictionary -
- 		- -
Specify time for overload mode reset
-
-
- allow_route_leaking - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow routes to be leaked when overload is configured.
-
-
- as_external - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise As External with maximum usable metric.
-
-
- stub_network - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Stub Network with maximum metric.
-
-
- timeout - -
- integer -
- 		- -
Time after which overload mode is reset (seconds).
-
-
- preference - -
- integer -
- 		- -
Preference of internal routes.
-
-
- prefix_export_limit - -
- integer -
- 		- -
Maximum number of external prefixes that can be exported.
-
-
- reference_bandwidth - -
- string -
- 		-
    Choices: -
  • 1g
    • -
  • 10g
    • -
- 		-
Bandwidth for calculating metric defaults.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set RFC1583 compatibility
-
-
- router_id - -
- string -
- 		- -
The OSPFv2 router id.
-
-
- spf_options - -
- dictionary -
- 		- -
Configure options for SPF.
-
-
- delay - -
- integer -
- 		- -
Time to wait before running an SPF (seconds).
-
-
- holddown - -
- integer -
- 		- -
Time to hold down before running an SPF (seconds).
-
-
- no_ignore_our_externals - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not ignore self-generated external and NSSA LSAs.
-
-
- rapid_runs - -
- integer -
- 		- -
Number of maximum rapid SPF runs before holddown (seconds).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show protocols ospf.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. - - See `the Junos OS Platform Options `_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state - # ------------ - # - # admin# show protocols ospf - - - name: Merge provided OSPFv2 configuration into running config. - junipernetworks.junos.junos_ospfv2: - config: - - reference_bandwidth: 10g - areas: - - area_id: 0.0.0.100 - area_ranges: - - address: 10.200.17.0/24 - exact: true - restrict: true - override_metric: 2000 - - address: 10.200.15.0/24 - exact: true - restrict: true - override_metric: 2000 - stub: - default_metric: 100 - set: true - interfaces: - - name: so-0/0/0.0 - priority: 3 - metric: 5 - flood_reduction: false - passive: true - bandwidth_based_metrics: - - bandwidth: 1g - metric: 5 - - bandwidth: 10g - metric: 40 - timers: - dead_interval: 4 - hello_interval: 2 - poll_interval: 2 - retransmit_interval: 2 - rfc1583compatibility: false - state: merged - - # Task Output: - # ------------ - # - # before: [] - # - # commands: - # - - # 10g - # 0.0.0.10010.200.17.0/24 - # 2000 - # 10.200.15.0/242000 - # so-0/0/0.03 - # 51g - # 510g40 - # 4 - # 22 - # 2 - # 100 - # - # after: - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.17.0/24'', ''10.200.15.0/24'']' - # area_ranges: - # - address: 10.200.17.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # - address: 10.200.15.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - - # After state - # ----------- - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.100 { - # stub default-metric 100; - # area-range 10.200.17.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # area-range 10.200.15.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # retransmit-interval 2; - # hello-interval 2; - # dead-interval 4; - # poll-interval 2; - # } - # } - # - # Using replaced - # - # Before state - # ------------ - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.100 { - # stub default-metric 100; - # area-range 10.200.17.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # area-range 10.200.15.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # retransmit-interval 2; - # hello-interval 2; - # dead-interval 4; - # poll-interval 2; - # } - # } - - - name: Replace existing Junos OSPFv2 config with provided config - junipernetworks.junos.junos_ospfv2: - config: - - reference_bandwidth: 10g - areas: - - area_id: 0.0.0.100 - area_ranges: - - address: 10.200.17.0/24 - exact: true - restrict: true - - address: 10.200.16.0/24 - exact: true - restrict: true - override_metric: 1000 - stub: - default_metric: 100 - set: true - interfaces: - - name: so-0/0/0.0 - priority: 3 - metric: 5 - flood_reduction: false - passive: true - bandwidth_based_metrics: - - bandwidth: 1g - metric: 5 - - bandwidth: 10g - metric: 40 - timers: - dead_interval: 4 - hello_interval: 2 - poll_interval: 2 - retransmit_interval: 2 - rfc1583compatibility: false - state: replacedd - - # Task Output: - # ------------ - # - # before: - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.17.0/24'', ''10.200.15.0/24'']' - # area_ranges: - # - address: 10.200.17.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # - address: 10.200.15.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - # - # commands: - # - - # 0.0.0.100 - # 10g - # 0.0.0.10010.200.17.0/24 - # 10.200.16.0/24 - # 1000 - # so-0/0/0.035 - # 1g5 - # 10g40 - # 42 - # 22 - # 100 - # - # after: - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.17.0/24'', ''10.200.16.0/24'']' - # area_ranges: - # - address: 10.200.17.0/24 - # exact: true - # restrict: true - # - address: 10.200.16.0/24 - # exact: true - # override_metric: 1000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - # - # After state - # ----------- - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.100 { - # stub default-metric 100; - # area-range 10.200.17.0/24 { - # restrict; - # exact; - # } - # area-range 10.200.16.0/24 { - # restrict; - # exact; - # override-metric 1000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # retransmit-interval 2; - # hello-interval 2; - # dead-interval 4; - # poll-interval 2; - # } - # } - # - # Using overridden - # - # Before state - # ------------ - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.100 { - # stub default-metric 100; - # area-range 10.200.17.0/24 { - # restrict; - # exact; - # } - # area-range 10.200.16.0/24 { - # restrict; - # exact; - # override-metric 1000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # retransmit-interval 2; - # hello-interval 2; - # dead-interval 4; - # poll-interval 2; - # } - # } - - - name: Override runnig OSPFv2 config with provided config - junipernetworks.junos.junos_ospfv2: - config: - - reference_bandwidth: 10g - areas: - - area_id: 0.0.0.110 - area_ranges: - - address: 20.200.17.0/24 - exact: true - restrict: true - override_metric: 2000 - - address: 20.200.15.0/24 - exact: true - restrict: true - override_metric: 2000 - stub: - default_metric: 200 - set: true - interfaces: - - name: so-0/0/0.0 - priority: 3 - metric: 5 - flood_reduction: false - passive: true - bandwidth_based_metrics: - - bandwidth: 1g - metric: 5 - - bandwidth: 10g - metric: 40 - state: overridden - - # Task Output: - # ------------ - # - # before: - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.17.0/24'', ''10.200.16.0/24'']' - # area_ranges: - # - address: 10.200.17.0/24 - # exact: true - # restrict: true - # - address: 10.200.16.0/24 - # exact: true - # override_metric: 1000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - # - # commands: - # - - # 0.0.0.100 - # 10g0.0.0.110 - # 20.200.17.0/24 - # 2000 - # 20.200.15.0/242000 - # so-0/0/0.03 - # 51g - # 510g40 - # - # 200 - # - # after: - # - areas: - # - area_id: 0.0.0.110 - # area_range: '[''20.200.17.0/24'', ''20.200.15.0/24'']' - # area_ranges: - # - address: 20.200.17.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # - address: 20.200.15.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # stub: - # default_metric: 200 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - - # After state - # ----------- - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.110 { - # stub default-metric 200; - # area-range 20.200.17.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # area-range 20.200.15.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # } - # } - # Using deleted - # - # Before state - # ------------ - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.110 { - # stub default-metric 200; - # area-range 20.200.17.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # area-range 20.200.15.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # } - # } - - - name: Delete OSPFv2 running config. - junipernetworks.junos.junos_ospfv2: - config: - state: deleted - - # Task Output: - # ------------ - # - # before: - # - areas: - # - area_id: 0.0.0.110 - # area_range: '[''20.200.17.0/24'', ''20.200.15.0/24'']' - # area_ranges: - # - address: 20.200.17.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # - address: 20.200.15.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # stub: - # default_metric: 200 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - # - # commands: - # - - # 0.0.0.100 - # - # - # after: [] - # - # - # After state - # ----------- - # - # admin# show protocols ospf - - # Using gathered - # - # Before state - # ------------ - # - # admin# show protocols ospf - # reference-bandwidth 10g; - # no-rfc-1583; - # area 0.0.0.100 { - # stub default-metric 100; - # area-range 10.200.17.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # area-range 10.200.15.0/24 { - # restrict; - # exact; - # override-metric 2000; - # } - # interface so-0/0/0.0 { - # passive; - # bandwidth-based-metrics { - # bandwidth 1g metric 5; - # bandwidth 10g metric 40; - # } - # metric 5; - # priority 3; - # retransmit-interval 2; - # hello-interval 2; - # dead-interval 4; - # poll-interval 2; - # } - # } - - - name: Gather Junos OSPFv2 running-configuration - junipernetworks.junos.junos_ospfv2: - config: - state: gathered - # - # - # Task Output: - # ------------ - # - # gathered: - # - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.17.0/24'', ''10.200.15.0/24'']' - # area_ranges: - # - address: 10.200.17.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # - address: 10.200.15.0/24 - # exact: true - # override_metric: 2000 - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # 10g - # - # - # 0.0.0.100 - # - # 100 - # - # - # 10.200.16.0/24 - # - # 10000 - # - # - # 10.200.11.0/24 - # - # - # - # - # so-0/0/0.0 - # - # - # - # - # 1g - # 5 - # - # - # 10g - # 40 - # - # - # 5 - # 3 - # 2 - # 2 - # 4 - # 2 - # - # - # - # - # - # - # - # 172.16.17.0/24 - # - # - # - # 10.200.16.75 - # - # 65432 - # - # - # - # - - - - name: Parsed the ospfv2 config into structured ansible resource facts. - junipernetworks.junos.junos_ospfv2: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - # - # Task Output: - # ------------ - # - # parsed: - # - areas: - # - area_id: 0.0.0.100 - # area_range: '[''10.200.16.0/24'', ''10.200.11.0/24'']' - # area_ranges: - # - address: 10.200.16.0/24 - # exact: true - # override_metric: 10000 - # - address: 10.200.11.0/24 - # exact: true - # restrict: true - # interfaces: - # - bandwidth_based_metrics: - # - bandwidth: 1g - # metric: 5 - # - bandwidth: 10g - # metric: 40 - # metric: 5 - # name: so-0/0/0.0 - # passive: true - # priority: 3 - # timers: - # dead_interval: 4 - # hello_interval: 2 - # poll_interval: 2 - # retransmit_interval: 2 - # stub: - # default_metric: 100 - # set: true - # reference_bandwidth: 10g - # rfc1583compatibility: false - # router_id: 10.200.16.75 - - # Using rendered - # - - name: Render the commands for provided configuration - junipernetworks.junos.junos_ospfv2: - config: - - reference_bandwidth: 10g - areas: - - area_id: 0.0.0.100 - area_ranges: - - address: 10.200.17.0/24 - exact: true - restrict: true - override_metric: 2000 - - address: 10.200.15.0/24 - exact: true - restrict: true - override_metric: 2000 - stub: - default_metric: 100 - set: true - interfaces: - - name: so-0/0/0.0 - priority: 3 - metric: 5 - flood_reduction: false - passive: true - bandwidth_based_metrics: - - bandwidth: 1g - metric: 5 - - bandwidth: 10g - metric: 40 - timers: - dead_interval: 4 - hello_interval: 2 - poll_interval: 2 - retransmit_interval: 2 - rfc1583compatibility: false - state: rendered - - # Task Output: - # ------------ - # - # rendered: " - # 10g0.0.0.100 - # 10.200.17.0/242000 - # 10.200.15.0/24 - # 2000so-0/0/0.0 - # 35 - # 1g510g - # 404 - # 22 - # 2 - # 100" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">< nc:ospf><nc:area delete="delete">0.0.0.100</nc:area><nc:reference-bandwidth delete="delete"/> <nc:no-rfc-1583 delete="delete"/></nc:ospf></nc:protocols>', 'xml 2', 'xml 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniel Mellado (@dmellado) -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_package_module.rst b/docs/junipernetworks.junos.junos_package_module.rst deleted file mode 100644 index 22887557..00000000 --- a/docs/junipernetworks.junos.junos_package_module.rst +++ /dev/null @@ -1,424 +0,0 @@ -.. _junipernetworks.junos.junos_package_module: - - -*********************************** -junipernetworks.junos.junos_package -*********************************** - -**Installs packages on remote devices running Junos** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can install new and updated packages on remote devices running Junos. The module will compare the specified package with the one running on the remote device and install the specified version if there is a mismatch - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- junos-eznc -- ncclient (>=v0.5.2) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- force - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The force argument instructs the module to bypass the package version check and install the packaged identified in src on the remote device.
-
-
- force_host - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The force_host argument controls the way software package or bundle is added on remote JUNOS host and is applicable for JUNOS QFX5100 device. If the value is set to True it will ignore any warnings while adding the host software package or bundle.
-
-
- issu - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The issu argument is a boolean flag when set to True allows unified in-service software upgrade (ISSU) feature which enables you to upgrade between two different Junos OS releases with no disruption on the control plane and with minimal disruption of traffic.
-
-
- no_copy - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The 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.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.
-
For more information please see the Junos OS Platform Options guide.
-
-
A dict object containing connection details.
-
-
- host - -
- string -
- 		- -
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.
-
-
- password - -
- string -
- 		- -
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
-
-
- port - -
- integer -
- 		- -
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device.
-
-
- ssh_keyfile - -
- path -
- 		- -
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
-
-
- timeout - -
- integer -
- 		- -
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
-
-
- transport - -
- string -
- 		-
    Choices: -
  • cli
    • -
  • netconf ←
    • -
- 		-
Configures the transport connection to use when connecting to the remote device.
-
-
- username - -
- string -
- 		- -
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
-
-
- reboot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
In order for a package to take effect, the remote device must be restarted. When enabled, this argument will instruct the module to reboot the device once the updated package has been installed. If disabled or the remote package does not need to be changed, the device will not be started.
-
-
- src - -
- path - / required -
- 		- -
The src argument specifies the path to the source package to be installed on the remote device in the advent of a version mismatch. The src argument can be either a localized path or a full path to the package file to install.
-

aliases: package
-
-
- ssh_config - -
- path -
- 		- -
The ssh_config argument is path to the SSH configuration file. This can be used to load SSH information from a configuration file. If this option is not given by default ~/.ssh/config is queried.
-
-
- ssh_private_key_file - -
- path -
- 		- -
The ssh_private_key_file argument is path to the SSH private key file. This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment
-
-
- unlink - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The unlink argument is responsible for instructing the remote device to remove the installation packages after installation.
-
-
- validate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
The validate argument is responsible for instructing the remote device to skip checking the current device configuration compatibility with the package being installed. When set to false validation is not performed.
-
-
- version - -
- string -
- 		- -
The version argument can be used to explicitly specify the version of the package that should be installed on the remote device. If the version argument is not specified, then the version is extracts from the src filename.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. - - Works with ``local`` connections only. - - Since this module uses junos-eznc to establish connection with junos device the netconf configuration parameters needs to be passed using module options for example ``ssh_config`` unlike other junos modules that uses ``netconf`` connection type. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - # the required set of connection arguments have been purposely left off - # the examples for brevity - - - name: install local package on remote device - junipernetworks.junos.junos_package: - src: junos-vsrx-12.1X46-D10.2-domestic.tgz - - - name: install local package on remote device without rebooting - junipernetworks.junos.junos_package: - src: junos-vsrx-12.1X46-D10.2-domestic.tgz - reboot: false - - - name: install local package on remote device with jumpost - junipernetworks.junos.junos_package: - src: junos-vsrx-12.1X46-D10.2-domestic.tgz - ssh_config: /home/user/customsshconfig - - - - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/junipernetworks.junos.junos_ping_module.rst b/docs/junipernetworks.junos.junos_ping_module.rst deleted file mode 100644 index 0c32f602..00000000 --- a/docs/junipernetworks.junos.junos_ping_module.rst +++ /dev/null @@ -1,366 +0,0 @@ -.. _junipernetworks.junos.junos_ping_module: - - -******************************** -junipernetworks.junos.junos_ping -******************************** - -**Tests reachability using ping from devices running Juniper JUNOS** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Tests reachability using ping from devices running Juniper JUNOS to a remote destination. -- Tested against Junos (17.3R1.10) -- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. -- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. -- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- count - -
- integer -
- 		- Default:
5
- 		-
Number of packets to send to check reachability.
-
-
- dest - -
- string - / required -
- 		- -
The IP Address or hostname (resolvable by the device) of the remote node.
-
-
- df_bit - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Determines whether to set the DF bit.
-
-
- interface - -
- string -
- 		- -
The source interface to use while sending the ping packet(s).
-
-
- interval - -
- integer -
- 		- -
Determines the interval (in seconds) between consecutive pings.
-
-
- rapid - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Determines whether to send the packets rapidly.
-
-
- size - -
- integer -
- 		- -
Determines the size (in bytes) of the ping packet(s).
-
-
- source - -
- string -
- 		- -
The IP Address to use while sending the ping packet(s).
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Determines if the expected result is success or fail.
-
-
- ttl - -
- integer -
- 		- -
The time-to-live value for the ICMP packet(s).
-
-
- - -Notes ------ - -.. note:: - - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. - - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. - - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - This module works only with connection ``network_cli``. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - - name: Test reachability to 10.10.10.10 - junipernetworks.junos.junos_ping: - dest: 10.10.10.10 - - - name: Test reachability to 10.20.20.20 using source and size set - junipernetworks.junos.junos_ping: - dest: 10.20.20.20 - size: 1024 - ttl: 128 - - - name: Test unreachability to 10.30.30.30 using interval - junipernetworks.junos.junos_ping: - dest: 10.30.30.30 - interval: 3 - state: absent - - - name: Test reachability to 10.40.40.40 setting count and interface - junipernetworks.junos.junos_ping: - dest: 10.40.40.40 - interface: fxp0 - count: 20 - size: 512 - - - name: Test reachability to 10.50.50.50 using do-not-fragment and rapid - junipernetworks.junos.junos_ping: - dest: 10.50.50.50 - df_bit: true - rapid: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
List of commands sent.
-
-
Sample:
-
['ping 10.8.38.44 count 10 source 10.8.38.38 ttl 128']
-
-
- packet_loss - -
- string -
- 		always -
Percentage of packets lost.
-
-
Sample:
-
0%
-
-
- packets_rx - -
- integer -
- 		always -
Packets successfully received.
-
-
Sample:
-
20
-
-
- packets_tx - -
- integer -
- 		always -
Packets successfully transmitted.
-
-
Sample:
-
20
-
-
- rtt - -
- dictionary -
- 		when ping succeeds -
The round trip time (RTT) stats.
-
-
Sample:
-
{'avg': 2, 'max': 8, 'min': 1, 'stddev': 24}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/junipernetworks.junos.junos_rpc_module.rst b/docs/junipernetworks.junos.junos_rpc_module.rst deleted file mode 100644 index b9683588..00000000 --- a/docs/junipernetworks.junos.junos_rpc_module.rst +++ /dev/null @@ -1,219 +0,0 @@ -.. _junipernetworks.junos.junos_rpc_module: - - -******************************* -junipernetworks.junos.junos_rpc -******************************* - -**Runs an arbitrary RPC over NetConf on an Juniper JUNOS device** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sends a request to the remote device running JUNOS to execute the specified RPC using the NetConf transport. The reply is then returned to the playbook in the ``xml`` key. If an alternate output format is requested, the reply is transformed to the requested output. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.5.2) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- args - -
- dictionary -
- 		- -
The args argument provides a set of arguments for the RPC call and are encoded in the request message. This argument accepts a set of key=value arguments.
-
-
- attrs - -
- dictionary -
- 		- -
The attrs arguments defines a list of attributes and their values to set for the RPC call. This accepts a dictionary of key-values.
-
-
- output - -
- string -
- 		-
    Choices: -
  • xml ←
    • -
  • json
    • -
  • text
    • -
- 		-
The output argument specifies the desired output of the return data. This argument accepts one of xml, text, or json. For json, the JUNOS device must be running a version of software that supports native JSON output.
-
-
- rpc - -
- string - / required -
- 		- -
The rpc argument specifies the RPC call to send to the remote devices to be executed. The RPC Reply message is parsed and the contents are returned to the playbook.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. - - Recommended connection is ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - This module also works with ``local`` connections for legacy playbooks. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - - name: collect interface information using rpc - junipernetworks.junos.junos_rpc: - rpc: get-interface-information - args: - interface-name: em0 - media: true - - - name: get system information - junipernetworks.junos.junos_rpc: - rpc: get-system-information - - - name: load configuration - junipernetworks.junos.junos_rpc: - rpc: load-configuration - attrs: - action: override - url: /tmp/config.conf - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- output - -
- string -
- 		always -
The rpc rely converted to the output format.
-
-
-
- output_lines - -
- list -
- 		always -
The text output split into lines for readability.
-
-
-
- xml - -
- string -
- 		always -
The xml return string from the rpc request.
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/junipernetworks.junos.junos_scp_module.rst b/docs/junipernetworks.junos.junos_scp_module.rst deleted file mode 100644 index 389939e1..00000000 --- a/docs/junipernetworks.junos.junos_scp_module.rst +++ /dev/null @@ -1,376 +0,0 @@ -.. _junipernetworks.junos.junos_scp_module: - - -******************************* -junipernetworks.junos.junos_scp -******************************* - -**Transfer files from or to remote devices running Junos** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2025-01-01 -:Why: Updated modules released with more functionality -:Alternative: Use :ref:`ansible.netcommon.net_get `, :ref:`ansible.netcommon.net_put ` instead. - - - -Synopsis --------- -- This module transfers files via SCP from or to remote devices running Junos. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- junos-eznc -- ncclient (>=v0.5.2) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- dest - -
- path -
- 		- Default:
"."
- 		-
The dest argument specifies the path in which to receive the files.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.
-
For more information please see the Junos OS Platform Options guide.
-
-
A dict object containing connection details.
-
-
- host - -
- string -
- 		- -
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.
-
-
- password - -
- string -
- 		- -
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
-
-
- port - -
- integer -
- 		- -
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device.
-
-
- ssh_keyfile - -
- path -
- 		- -
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
-
-
- timeout - -
- integer -
- 		- -
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
-
-
- transport - -
- string -
- 		-
    Choices: -
  • cli
    • -
  • netconf ←
    • -
- 		-
Configures the transport connection to use when connecting to the remote device.
-
-
- username - -
- string -
- 		- -
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
-
-
- recursive - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The recursive argument enables recursive transfer of files and directories.
-
-
- remote_src - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The remote_src argument enables the download of files (scp get) from the remote device. The default behavior is to upload files (scp put) to the remote device.
-
-
- src - -
- list - / elements=path - / required -
- 		- -
The src argument takes a single path, or a list of paths to be transferred. The argument recursive must be true to transfer directories.
-
-
- ssh_config - -
- path -
- 		- -
The ssh_config argument is path to the SSH configuration file. This can be used to load SSH information from a configuration file. If this option is not given by default ~/.ssh/config is queried.
-
-
- ssh_private_key_file - -
- path -
- 		- -
The ssh_private_key_file argument is path to the SSH private key file. This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vMX JUNOS version 17.3R1.10. - - Works with ``local`` connections only. - - Since this module uses junos-eznc to establish connection with junos device the netconf configuration parameters needs to be passed using module options for example ``ssh_config`` unlike other junos modules that uses ``netconf`` connection type. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - # the required set of connection arguments have been purposely left off - # the examples for brevity - - name: upload local file to home directory on remote device - junipernetworks.junos.junos_scp: - src: test.tgz - - - name: upload local file to tmp directory on remote device - junipernetworks.junos.junos_scp: - src: test.tgz - dest: /tmp/ - - - name: download file from remote device - junipernetworks.junos.junos_scp: - src: test.tgz - remote_src: true - - - name: ssh config file path for jumphost config - junipernetworks.junos.junos_scp: - src: test.tgz - remote_src: true - ssh_config: /home/user/customsshconfig - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
always true
-
-
-

- - -Status ------- - - -- This module will be removed in a release after 2025-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Christian Giese (@GIC-de) diff --git a/docs/junipernetworks.junos.junos_snmp_server_module.rst b/docs/junipernetworks.junos.junos_snmp_server_module.rst deleted file mode 100644 index 35996ebf..00000000 --- a/docs/junipernetworks.junos.junos_snmp_server_module.rst +++ /dev/null @@ -1,6131 +0,0 @@ -.. _junipernetworks.junos.junos_snmp_server_module: - - -*************************************** -junipernetworks.junos.junos_snmp_server -*************************************** - -**Manage SNMP server configuration on Junos devices.** - - -Version added: 2.9.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages SNMP server configuration on devices running Junos. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12.0) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of SNMP server configuration.
-
-
- arp - -
- dictionary -
- 		- -
Specify JVision arp setting.
-
-
- host_name_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable host name resolution.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set JVision arp.
-
-
- client_lists - -
- list - / elements=dictionary -
- 		- -
Specify client list.
-
-
- addresses - -
- list - / elements=dictionary -
- 		- -
Specify list of addresses/prefixes.
-
-
- address - -
- string -
- 		- -
Specify address or prefix.
-
-
- restrict - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Deny access.
-
-
- name - -
- string -
- 		- -
Specify client list name.
-
-
- communities - -
- list - / elements=dictionary -
- 		- -
Specify list of community string.
-
-
- authorization - -
- string -
- 		-
    Choices: -
  • read-only
    • -
  • read-write
    • -
- 		-
Specify Authorization type.
-
-
- client_list_name - -
- string -
- 		- -
Specify the name of client list or prefix list.
-
-
- clients - -
- list - / elements=dictionary -
- 		- -
Specify List of source address prefix ranges to accept.
-
-
- address - -
- string -
- 		- -
Specify address or prefix.
-
-
- restrict - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Deny access.
-
-
- logical_system - -
- list - / elements=string -
- 		- -
Use logical-system name for v1/v2c clients.
-
-
- name - -
- string -
- 		- -
Specify name of the community.
-
-
- routing_instances - -
- list - / elements=dictionary -
- 		- -
Use routing-instance name for v1/v2c clients.
-
-
- client_list_name - -
- string -
- 		- -
Specify the name of client list or prefix list.
-
-
- clients - -
- list - / elements=dictionary -
- 		- -
Specify List of source address prefix ranges to accept.
-
-
- address - -
- string -
- 		- -
Specify address or prefix.
-
-
- restrict - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Deny access.
-
-
- name - -
- string -
- 		- -
Specify routing-instances.
-
-
- view - -
- string -
- 		- -
Specify view name.
-
-
- contact - -
- string -
- 		- -
Specify contact information for administrator.
-
-
- customization - -
- dictionary -
- 		- -
Customize SNMP behaviour based on knob.
-
-
- ether_stats_ifd_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
To stop exposing IFLs as part of etherStatsTable.
-
-
- description - -
- string -
- 		- -
System description.
-
-
- engine_id - -
- dictionary -
- 		- -
Specify SNMPv3 engine ID
-
-
- local - -
- string -
- 		- -
Local engine ID.
-
-
- use_default_ip_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use default IP address for the engine ID.
-
-
- use_mac_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Uses management interface MAC Address for the engine ID.
-
-
- filter_duplicates - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Filter requests with duplicate source address/port and request ID.
-
-
- filter_interfaces - -
- dictionary -
- 		- -
List of interfaces that needs to be filtered.
-
-
- all_internal_interfaces - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Filter all internal interfaces.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Specify filter specified interfaces.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set filter-interfaces.
-
-
- health_monitor - -
- dictionary -
- 		- -
Specify health monitoring configuration.
-
-
- falling_threshold - -
- integer -
- 		- -
Falling threshold applied to all monitored objects.
-
-
- idp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IDP health monitor configuration.
-
-
- interval - -
- integer -
- 		- -
Interval between samples.
-
-
- rising_threshold - -
- integer -
- 		- -
Rising threshold applied to all monitored objects.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set health-monitor configuration.
-
-
- if_count_with_filter_interfaces - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Filter interfaces config for ifNumber and ipv6Interfaces.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Restrict SNMP requests to interfaces.
-
-
- location - -
- string -
- 		- -
Specify physical location of system.
-
-
- logical_system_trap_filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow only logical-system specific traps.
-
-
- name - -
- string -
- 		- -
System name override.
-
-
- nonvolatile - -
- dictionary -
- 		- -
Configure the handling of nonvolatile SNMP Set requests.
-
-
- commit_delay - -
- integer -
- 		- -
Delay between affirmative SNMP Set reply and start of commit (seconds).
-
-
- proxies - -
- list - / elements=dictionary -
- 		- -
SNMP proxy configuration.
-
-
- device_name - -
- string -
- 		- -
Satellite/Proxied Device name or IP address.
-
-
- logical_system - -
- list - / elements=string -
- 		- -
Use logical-system name for v1/v2c clients.
-
-
- name - -
- string -
- 		- -
Specify proxy name.
-
-
- routing_instances - -
- list - / elements=dictionary -
- 		- -
Use routing-instance name for v1/v2c clients.
-
-
- client_list_name - -
- string -
- 		- -
Specify the name of client list or prefix list.
-
-
- clients - -
- list - / elements=dictionary -
- 		- -
Specify List of source address prefix ranges to accept.
-
-
- address - -
- string -
- 		- -
Specify address or prefix.
-
-
- restrict - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Deny access.
-
-
- name - -
- string -
- 		- -
Specify routing-instances.
-
-
- version_v1 - -
- dictionary -
- 		- -
Specify For v1 proxy configuration define snmp-community.
-
-
- no_default_comm_to_v3_config - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify No default snmp-community and v3 configuration.
-
-
- snmp_community - -
- string -
- 		- -
Specify community name.
-
-
- version_v2c - -
- dictionary -
- 		- -
For v2c proxy configuration define snmp-community.
-
-
- no_default_comm_to_v3_config - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify No default snmp-community and v3 configuration.
-
-
- snmp_community - -
- string -
- 		- -
Specify community name.
-
-
- version_v3 - -
- dictionary -
- 		- -
For v3 proxy configuration define security-name.
-
-
- context - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
pecify context name associated to this security-name.
-
-
- security_name - -
- string -
- 		- -
Specify v3 security-name.
-
-
- rmon - -
- dictionary -
- 		- -
Specify Remote Monitoring configuration.
-
-
- alarms - -
- list - / elements=dictionary -
- 		- -
RMON alarm entries.
-
-
- description - -
- string -
- 		- -
General description of alarm (stored in alarmOwner).
-
-
- falling_event_index - -
- integer -
- 		- -
Event triggered after falling threshold is crossed.
-
-
- falling_threshold - -
- integer -
- 		- -
Specify falling-threshold.
-
-
- falling_threshold_interval - -
- integer -
- 		- -
Interval between samples during falling-threshold test.
-
-
- id - -
- string -
- 		- -
Specify alarm ID.
-
-
- interval - -
- integer -
- 		- -
Interval between samples.
-
-
- request_type - -
- string -
- 		-
    Choices: -
  • get-next-request
    • -
  • get-request
    • -
  • walk-request
    • -
- 		-
Type of SNMP request to issue for alarm.
-
-
- rising_event_index - -
- integer -
- 		- -
Event triggered after rising threshold is crossed.
-
-
- rising_threshold - -
- integer -
- 		- -
The rising threshold.
-
-
- sample_type - -
- string -
- 		-
    Choices: -
  • absolute-value
    • -
  • delta-value
    • -
- 		-
Method of sampling the selected variable.
-
-
- startup_alarm - -
- string -
- 		-
    Choices: -
  • falling-alarm
    • -
  • rising-alarm
    • -
  • rising-or-falling-alarm
    • -
- 		-
The alarm that may be sent upon entry startup.
-
-
- syslog_subtag - -
- string -
- 		- -
Tag to be added to syslog messages.
-
-
- variable - -
- string -
- 		- -
OID of MIB variable to be monitored.
-
-
- events - -
- list - / elements=dictionary -
- 		- -
RMON event entries.
-
-
- community - -
- string -
- 		- -
The community (trap group) for outgoing traps.
-
-
- description - -
- string -
- 		- -
General description of event.
-
-
- id - -
- integer -
- 		- -
Specify event ID.
-
-
- type - -
- string -
- 		-
    Choices: -
  • log
    • -
  • log-and-trap
    • -
  • none
    • -
  • snmptrap
    • -
- 		-
The type of notification for this event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set Remote monitoring configuration.
-
-
- routing_instance_access - -
- dictionary -
- 		- -
SNMP routing-instance options.
-
-
- access_lists - -
- list - / elements=string -
- 		- -
Allow/Deny SNMP access to routing-instances.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set routing_instance_access.
-
-
- snmp_v3 - -
- dictionary -
- 		- -
SNMPv3 configuration information.
-
-
- notify - -
- list - / elements=dictionary -
- 		- -
Used to select management targets for notifications as well as the type of notifications.
-
-
- name - -
- string -
- 		- -
Specify notify name.
-
-
- tag - -
- string -
- 		- -
Notifications will be sent to all targets configured with this tag.
-
-
- type - -
- string -
- 		- -
Notification type.
-
-
- notify_filter - -
- list - / elements=dictionary -
- 		- -
Filters to apply to SNMP notifications.
-
-
- name - -
- string -
- 		- -
Specify notify filter name.
-
-
- oids - -
- list - / elements=dictionary -
- 		- -
OID to include/exclude from notify filter.
-
-
- exclude - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Exclude this OID from the notify filtered.
-
-
- include - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include this OID in the notify filter.
-
-
- oid - -
- string -
- 		- -
Specify OID.
-
-
- snmp_community - -
- list - / elements=dictionary -
- 		- -
SNMP community and view-based access control model configuration.
-
-
- community_index - -
- string -
- 		- -
Unique index value in this community table entry.
-
-
- community_name - -
- string -
- 		- -
SNMPv1/v2c community name (default is same as community-index).
-
-
- context - -
- string -
- 		- -
Context used when performing access control.
-
-
- security_name - -
- string -
- 		- -
Security name used when performing access control.
-
-
- tag - -
- string -
- 		- -
Tag identifier for set of targets allowed to use this community string.
-
-
- target_addresses - -
- list - / elements=dictionary -
- 		- -
Identifies notification targets as well as allowed management stations.
-
-
- address - -
- string -
- 		- -
SNMP target address.
-
-
- address_mask - -
- string -
- 		- -
Mask range of addresses for community string access control.
-
-
- logical_system - -
- string -
- 		- -
Logical-system name for trap destination.
-
-
- name - -
- string -
- 		- -
SNMP target address name.
-
-
- port - -
- integer -
- 		- -
SNMP target port number.
-
-
- retry_count - -
- integer -
- 		- -
Maximum retry count for confirmed SNMP notifications.
-
-
- routing_instance - -
- string -
- 		- -
Routing instance for trap destination.
-
-
- tag_list - -
- string -
- 		- -
SNMP tag list used to select target addresses.
-
-
- target_parameters - -
- string -
- 		- -
SNMPv3 target parameter name in the target parameters table.
-
-
- timeout - -
- integer -
- 		- -
Acknowledgment timeout for confirmed SNMP notifications (seconds).
-
-
- target_parameters - -
- list - / elements=dictionary -
- 		- -
SNMPv3 target parameter name in the target parameters table.
-
-
- name - -
- string -
- 		- -
SNMPv3 target parameters name.
-
-
- notify_filter - -
- string -
- 		- -
Notify filter with filter name to apply to notifications.
-
-
- parameters - -
- dictionary -
- 		- -
Parameters used when sending notifications.
-
-
- message_processing_model - -
- string -
- 		-
    Choices: -
  • v1
    • -
  • v2c
    • -
  • v3
    • -
- 		-
The message processing model to be used when generating SNMP notifications.
-
-
- security_level - -
- string -
- 		-
    Choices: -
  • authentication
    • -
  • none
    • -
  • privacy
    • -
- 		-
Security-level used when generating SNMP notifications.
-
-
- security_model - -
- string -
- 		-
    Choices: -
  • usm
    • -
  • v1
    • -
  • v2c
    • -
- 		-
Security-model used when generating SNMP notifications.
-
-
- security_name - -
- string -
- 		- -
Security name used when generating SNMP notifications.
-
-
- usm - -
- dictionary -
- 		- -
User-based security model (USM) information.
-
-
- local_engine - -
- dictionary -
- 		- -
Local engine user configuration.
-
-
- users - -
- list - / elements=dictionary -
- 		- -
SNMPv3 USM user information.
-
-
- authentication_md5 - -
- dictionary -
- 		- -
Configure MD5 authentication.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user authentication.
-
-
- password - -
- string -
- 		- -
User's authentication password
-
-
- authentication_none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set no authentication for the user.
-
-
- authentication_sha - -
- dictionary -
- 		- -
Configure SHA authentication.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user authentication.
-
-
- password - -
- string -
- 		- -
User's authentication password
-
-
- name - -
- string -
- 		- -
User name.
-
-
- privacy_3des - -
- dictionary -
- 		- -
Configure Triple DES privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_aes128 - -
- dictionary -
- 		- -
Configure AES128 privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_des - -
- dictionary -
- 		- -
Configure DES privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set no privacy for the user.
-
-
- remote_engine - -
- list - / elements=dictionary -
- 		- -
Remote engine user configuration.
-
-
- id - -
- string -
- 		- -
Remote engine id.
-
-
- users - -
- list - / elements=dictionary -
- 		- -
SNMPv3 USM user information.
-
-
- authentication_md5 - -
- dictionary -
- 		- -
Configure MD5 authentication.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user authentication.
-
-
- password - -
- string -
- 		- -
User's authentication password
-
-
- authentication_none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set no authentication for the user.
-
-
- authentication_sha - -
- dictionary -
- 		- -
Configure SHA authentication.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user authentication.
-
-
- password - -
- string -
- 		- -
User's authentication password
-
-
- name - -
- string -
- 		- -
User name.
-
-
- privacy_3des - -
- dictionary -
- 		- -
Configure Triple DES privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_aes128 - -
- dictionary -
- 		- -
Configure AES128 privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_des - -
- dictionary -
- 		- -
Configure DES privacy.
-
-
- key - -
- string -
- 		- -
Encrypted key used for user privacy.
-
-
- password - -
- string -
- 		- -
User's privacy password
-
-
- privacy_none - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set no privacy for the user.
-
-
- subagent - -
- dictionary -
- 		- -
SNMP subagent configuration.
-
-
- tcp - -
- dictionary -
- 		- -
Allow SNMP subagent tcp connection.
-
-
- routing_instances_default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify routing-instance name for tcp connection.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set SNMP subagent TCP.
-
-
- traceoptions - -
- dictionary -
- 		- -
Configure trace options for SNMP.
-
-
- file - -
- dictionary -
- 		- -
Specify trace file options.
-
-
- files - -
- integer -
- 		- -
Specify maximum number of trace files.
-
-
- match - -
- string -
- 		- -
Regular expression for lines to be logged.
-
-
- no_world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't allow any user to read the log file.
-
-
- size - -
- integer -
- 		- -
Specify maximum trace file size.
-
-
- world_readable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow any user to read the log file.
-
-
- flag - -
- dictionary -
- 		- -
Specify flag traceoptions.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace everything.
-
-
- general - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace general events.
-
-
- interface_stats - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace interface statistics (logical and physical).
-
-
- nonvolatile_sets - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Nonvolatile SNMP set request handling.
-
-
- pdu - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dump SNMP request/response packets.
-
-
- protocol_timeouts - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace SNMP request timeouts.
-
-
- routing_socket - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace routing socket calls.
-
-
- subagent - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace master-agent interations with sub-agents.
-
-
- timer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace internal timer events.
-
-
- varbind_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Trace varbind errors.
-
-
- memory_trace - -
- dictionary -
- 		- -
Memory tracing information.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
set memory traceoptions.
-
-
- size - -
- integer -
- 		- -
Specify Memory size reserved for tracing.
-
-
- no_remote_trace - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable remote tracing.
-
-
- trap_groups - -
- list - / elements=dictionary -
- 		- -
Specify SNMP trap options.
-
-
- categories - -
- dictionary -
- 		- -
Specify Trap categories.
-
-
- authentication - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Authentication failures.
-
-
- chassis - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Chassis or environment notifications.
-
-
- chassis_cluster - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify Clustering notifications.
-
-
- configuration - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configuration notifications.
-
-
- dot3oam_events - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify 802.3ah notifications.
-
-
- link - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Link up-down transitions.
-
-
- otn_alarms - -
- dictionary -
- 		- -
OTN alarm trap subcategories.
-
-
- oc_lof - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Loss of frame alarm notifications.
-
-
- oc_lom - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Loss of multiframe alarm notification.
-
-
- oc_los - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Loss of signal alarm notification.
-
-
- odu_ais - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Alarm indication signal alarm notification.
-
-
- odu_bbe_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Background block error threshold alarm notification.
-
-
- odu_bdi - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Backward defect indication alarm notification.
-
-
- odu_bdodu_es_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Errored Second threshold alarm notification.
-
-
- odu_lck - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Locked alarm notification.
-
-
- odu_oci - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Open connection indicator alarm notifications.
-
-
- odu_rx_aps_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Receive APS change notifications.
-
-
- odu_sd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Signal degrade alarm notifications.
-
-
- odu_ses_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Severely Errored Second threshold alarm notification.
-
-
- odu_sf - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Signal fail alarm notification.
-
-
- odu_ttim - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Trace identification mismatch alarm notification.
-
-
- odu_uas_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Unavailable Second threshold alarm notification.
-
-
- opu_ptm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
ODU Payload Type Mismatch alarm notification.
-
-
- otu_ais - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Alarm indication signal alarm notification.
-
-
- otu_bbe_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Background block error threshold alarm notification.
-
-
- otu_bdi - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Backward defect indication alarm notification.
-
-
- otu_es_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Errored Second threshold alarm notification.
-
-
- otu_fec_deg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Fec degraded errors alarm notification.
-
-
- otu_fec_exe - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Fec excessive errors alarm notification.
-
-
- otu_iae - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Incoming alignment error alarm notification.
-
-
- otu_sd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Signal degrade alarm notification.
-
-
- otu_ses_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Severely Errored Second threshold alarm notification.
-
-
- otu_sf - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Signal fail alarm notification.
-
-
- otu_ttim - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Trace identification mismatch alarm notification.
-
-
- otu_uas_threshold - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OTU Unavailable Second threshold alarm notification.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set otn_alarms.
-
-
- wavelength_lock - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Wavelength lock alarm notification.
-
-
- remote_operations - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remote operations.
-
-
- rmon_alarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
RMON rising and falling alarms.
-
-
- routing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Routing protocol notifications.
-
-
- services - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Services notifications.
-
-
- startup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
System warm and cold starts.
-
-
- vrrp_events - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
VRRP notifications.
-
-
- destination_port - -
- integer -
- 		- -
SNMP trap receiver port number
-
-
- logical_system - -
- list - / elements=string -
- 		- -
Use logical-system name for v1/v2c clients.
-
-
- name - -
- string -
- 		- -
Specify trap group name.
-
-
- routing_instance - -
- string -
- 		- -
Routing instance for trap destination.
-
-
- targets - -
- list - / elements=string -
- 		- -
Targets for trap messages
-
-
- version - -
- string -
- 		-
    Choices: -
  • all
    • -
  • v1
    • -
  • v2
    • -
- 		-
SNMP version.
-
-
- trap_options - -
- dictionary -
- 		- -
SNMP trap options.
-
-
- agent_address - -
- dictionary -
- 		- -
Agent address for v1 trap PDUs.
-
-
- outgoing_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use address on outgoing interfaces.
-
-
- context_oid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add context oid in varbind of all traps at the end.
-
-
- enterprise_oid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add snmpTrapEnterprise oid in varbind of all traps.
-
-
- logical_system - -
- list - / elements=string -
- 		- -
Use logical-system name for v1/v2c clients.
-
-
- routing_instance - -
- string -
- 		- -
Specify routing-instance.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set trap options.
-
-
- source_address - -
- dictionary -
- 		- -
IPv4/IPv6 source address for trap PDUs.
-
-
- address - -
- string -
- 		- -
Use specified address.
-
-
- lowest_loopback - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use lowest address on loopback interfaces.
-
-
- views - -
- list - / elements=dictionary -
- 		- -
Define MIB views.
-
-
- name - -
- string -
- 		- -
MIB view name.
-
-
- oids - -
- list - / elements=dictionary -
- 		- -
OID include/exclude list
-
-
- exclude - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Exclude this OID from the view.
-
-
- include - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Include this OID from the view.
-
-
- oid - -
- string -
- 		- -
OID to include or exclude from view.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show system snmp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • overridden
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. - - See `the Junos OS Platform Options `_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # - # Before state - # ------------ - # - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - - name: Merge provided SNMP configuration into running configuration. - junipernetworks.junos.junos_snmp_server: - config: - arp: - set: true - host_name_resolution: true - client_lists: # ATTR-----2 - - name: cl1 - addresses: - - address: "192.16.1.0/24" - - address: "192.16.2.0/24" - - address: "11.11.11.11" - restrict: true - - name: cl2 - addresses: - - address: "192.16.4.0/24" - routing_instance_access: # ATTR-----3 - set: true - access_lists: - - "clv1" - - "clv2" - state: merged - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "arp": { - # "host_name_resolution": true - # }, - # "client_lists": [ - # { - # "addresses": [ - # { - # "address": "192.16.1.0/24" - # }, - # { - # "address": "192.16.2.0/24" - # }, - # { - # "address": "11.11.11.11/32", - # "restrict": true - # } - # ], - # "name": "cl1" - # }, - # { - # "addresses": [ - # { - # "address": "192.16.4.0/24" - # } - # ], - # "name": "cl2" - # } - # ], - # "routing_instance_access": { - # "access_lists": [ - # "clv1", - # "clv2" - # ] - # } - # }, - # "before": {}, - # "changed": true, - # "commands": [ - # "" - # "cl1" - # "192.16.1.0/24" - # "192.16.2.0/24" - # "11.11.11.11" - # "cl2192.16.4.0/24" - # "clv1" - # "clv2" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show snmp - # client-list cl1 { - # 192.16.1.0/24; - # 192.16.2.0/24; - # 11.11.11.11/32 { - # restrict; - # } - # } - # client-list cl2 { - # 192.16.4.0/24; - # } - # routing-instance-access { - # access-list { - # clv1; - # clv2; - # } - # } - # arp { - # host-name-resolution; - # } - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - # - # Using Replaced - # Before state - # ------------ - # - # vagrant@vsrx# show snmp - # client-list cl1 { - # 192.16.1.0/24; - # 192.16.2.0/24; - # 11.11.11.11/32 { - # restrict; - # } - # } - # client-list cl2 { - # 192.16.4.0/24; - # } - # routing-instance-access { - # access-list { - # clv1; - # clv2; - # } - # } - # arp { - # host-name-resolution; - # } - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - - - name: Replaced running SNMP server configuration with provided configuration - junipernetworks.junos.junos_snmp_server: - config: - contact: "ansiblesupport11@redhat.com" - customization: - ether_stats_ifd_only: true - description: "Local SNMP Server" - engine_id: - local: "local1" - use_default_ip_address: true - use_mac_address: true - filter_duplicates: true - filter_interfaces: - set: true - all_internal_interfaces: true - interfaces: - - "eth1" - - "eth2" - state: replaced - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "contact": "ansiblesupport11@redhat.com", - # "customization": { - # "ether_stats_ifd_only": true - # }, - # "description": "Local SNMP Server", - # "engine_id": { - # "use_mac_address": true - # }, - # "filter_duplicates": true, - # "filter_interfaces": { - # "all_internal_interfaces": true, - # "interfaces": [ - # "eth1", - # "eth2" - # ] - # } - # }, - # "before": - # { - # "arp": { - # "host_name_resolution": true - # }, - # "client_lists": [ - # { - # "addresses": [ - # { - # "address": "192.16.1.0/24" - # }, - # { - # "address": "192.16.2.0/24" - # }, - # { - # "address": "11.11.11.11/32", - # "restrict": true - # } - # ], - # "name": "cl1" - # }, - # { - # "addresses": [ - # { - # "address": "192.16.4.0/24" - # } - # ], - # "name": "cl2" - # } - # ], - # "routing_instance_access": { - # "access_lists": [ - # "clv1", - # "clv2" - # ] - # } - # }, - # "changed": true, - # "commands": [ - # "", - # "", - # "" - # "ansiblesupport11@redhat.com" - # "Local SNMP Server" - # "local1" - # "" - # "eth1eth2" - # "" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - # vagrant@vsrx# show snmp - # description "Local SNMP Server"; - # contact "ansiblesupport11@redhat.com"; - # filter-interfaces { - # interfaces { - # eth1; - # eth2; - # } - # all-internal-interfaces; - # } - # filter-duplicates; - # engine-id { - # use-mac-address; - # } - # customization { - # ether-stats-ifd-only; - # } - - # Using overridden - # - # Before state - # ------------ - # - # vagrant@vsrx# show snmp - # client-list cl1 { - # 192.16.1.0/24; - # 192.16.2.0/24; - # 11.11.11.11/32 { - # restrict; - # } - # } - # client-list cl2 { - # 192.16.4.0/24; - # } - # routing-instance-access { - # access-list { - # clv1; - # clv2; - # } - # } - # arp { - # host-name-resolution; - # } - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - - name: Override running SNMP server configuration with provided configuration - junipernetworks.junos.junos_snmp_server: - config: - contact: "ansiblesupport11@redhat.com" - customization: - ether_stats_ifd_only: true - description: "Local SNMP Server" - engine_id: - local: "local1" - use_default_ip_address: true - use_mac_address: true - filter_duplicates: true - filter_interfaces: - set: true - all_internal_interfaces: true - interfaces: - - "eth1" - - "eth2" - state: overridden - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": { - # "contact": "ansiblesupport11@redhat.com", - # "customization": { - # "ether_stats_ifd_only": true - # }, - # "description": "Local SNMP Server", - # "engine_id": { - # "use_mac_address": true - # }, - # "filter_duplicates": true, - # "filter_interfaces": { - # "all_internal_interfaces": true, - # "interfaces": [ - # "eth1", - # "eth2" - # ] - # } - # }, - # "before": - # { - # "arp": { - # "host_name_resolution": true - # }, - # "client_lists": [ - # { - # "addresses": [ - # { - # "address": "192.16.1.0/24" - # }, - # { - # "address": "192.16.2.0/24" - # }, - # { - # "address": "11.11.11.11/32", - # "restrict": true - # } - # ], - # "name": "cl1" - # }, - # { - # "addresses": [ - # { - # "address": "192.16.4.0/24" - # } - # ], - # "name": "cl2" - # } - # ], - # "routing_instance_access": { - # "access_lists": [ - # "clv1", - # "clv2" - # ] - # } - # }, - # "changed": true, - # "commands": [ - # "", - # "", - # "" - # "ansiblesupport11@redhat.com" - # "Local SNMP Server" - # "local1" - # "" - # "eth1eth2" - # "" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - # vagrant@vsrx# show snmp - # description "Local SNMP Server"; - # contact "ansiblesupport11@redhat.com"; - # filter-interfaces { - # interfaces { - # eth1; - # eth2; - # } - # all-internal-interfaces; - # } - # filter-duplicates; - # engine-id { - # use-mac-address; - # } - # customization { - # ether-stats-ifd-only; - # } - # - # Using deleted - # - # Before state - # ------------ - # - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - # vagrant@vsrx# show snmp - # description "Local SNMP Server"; - # contact "ansiblesupport11@redhat.com"; - # filter-interfaces { - # interfaces { - # eth1; - # eth2; - # } - # all-internal-interfaces; - # } - # filter-duplicates; - # engine-id { - # use-mac-address; - # } - # customization { - # ether-stats-ifd-only; - # } - # - - name: Delete running SNMP server configuration - junipernetworks.junos.junos_snmp_server: - config: - state: deleted - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "after": {}, - # "before": { - # "contact": "ansiblesupport11@redhat.com", - # "customization": { - # "ether_stats_ifd_only": true - # }, - # "description": "Local SNMP Server", - # "engine_id": { - # "use_mac_address": true - # }, - # "filter_duplicates": true, - # "filter_interfaces": { - # "all_internal_interfaces": true, - # "interfaces": [ - # "eth1", - # "eth2" - # ] - # } - # }, - # "changed": true, - # "commands": [ - # "", - # "" - # ] - # After state - # ----------- - # - # vagrant@vsrx# show routing-instances - # clv1 { - # description clv1; - # } - # clv2 { - # description clv2; - # } - # vagrant@vsrx# show snmp - # description "Local SNMP Server"; - # contact "ansiblesupport11@redhat.com"; - # filter-interfaces { - # interfaces { - # eth1; - # eth2; - # } - # all-internal-interfaces; - # } - # filter-duplicates; - # engine-id { - # use-mac-address; - # } - # customization { - # ether-stats-ifd-only; - # } - # - - name: Gather running SNMP server configuration - junipernetworks.junos.junos_snmp_server: - state: gathered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "gathered": { - # "contact": "ansiblesupport11@redhat.com", - # "customization": { - # "ether_stats_ifd_only": true - # }, - # "description": "Local SNMP Server", - # "engine_id": { - # "use_mac_address": true - # }, - # "filter_duplicates": true, - # "filter_interfaces": { - # "all_internal_interfaces": true, - # "interfaces": [ - # "eth1", - # "eth2" - # ] - # } - # }, - # "changed": false, - # Using rendered - # - # Before state - # ------------ - # - - name: Render xml for provided facts. - junipernetworks.junos.junos_snmp_server: - config: - arp: - set: true - host_name_resolution: true - routing_instance_access: # ATTR-----3 - set: true - access_lists: - - "clv1" - - "clv2" - state: rendered - # - # ------------------------- - # Module Execution Result - # ------------------------- - # "rendered": [ - # "" - # "" - # "clv1clv2" - # "" - # ] - # - # Using parsed - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # - # cl1 - # - # 192.16.1.0/24 - # - # - # 192.16.2.0/24 - # - # - # 11.11.11.11/32 - # - # - # - # - # cl2 - # - # 192.16.4.0/24 - # - # - # - # - # clv1 - # - # - # clv2 - # - # - # - # - # - # - # - # - # - # - - name: Parse SNMP server running config - junipernetworks.junos.junos_snmp_server: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - # - # - # ------------------------- - # Module Execution Result - # ------------------------- - # - # - # "parsed": { - # "arp": { - # "host_name_resolution": true - # }, - # "client_lists": [ - # { - # "addresses": [ - # { - # "address": "192.16.1.0/24" - # }, - # { - # "address": "192.16.2.0/24" - # }, - # { - # "address": "11.11.11.11/32", - # "restrict": true - # } - # ], - # "name": "cl1" - # }, - # { - # "addresses": [ - # { - # "address": "192.16.4.0/24" - # } - # ], - # "name": "cl2" - # } - # ], - # "routing_instance_access": { - # "access_lists": [ - # "clv1", - # "clv2" - # ] - # } - # } - # - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['<nc:arp><nc:host-name-resolution/></nc:arp><nc:routing-instance-access>"', '<nc:snmp xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Rohit Thakur (@rohitthakur2590) diff --git a/docs/junipernetworks.junos.junos_static_routes_module.rst b/docs/junipernetworks.junos.junos_static_routes_module.rst deleted file mode 100644 index 9d275e41..00000000 --- a/docs/junipernetworks.junos.junos_static_routes_module.rst +++ /dev/null @@ -1,714 +0,0 @@ -.. _junipernetworks.junos.junos_static_routes_module: - - -***************************************** -junipernetworks.junos.junos_static_routes -***************************************** - -**Static routes resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of static routes on Juniper JUNOS devices - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.6.4) -- xmltodict (>=0.12) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of static routes options
-
-
- address_families - -
- list - / elements=dictionary -
- 		- -
Address family to use for the static routes
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
afi to use for the static routes
-
-
- routes - -
- list - / elements=dictionary -
- 		- -
Static route configuration
-
-
- dest - -
- string -
- 		- -
Static route destination including prefix
-
-
- metric - -
- integer -
- 		- -
Metric value for the static route
-
-
- next_hop - -
- list - / elements=dictionary -
- 		- -
Next hop to destination
-
-
- forward_router_address - -
- string -
- 		- -
List of next hops
-
-
- vrf - -
- string -
- 		- -
Virtual Routing and Forwarding (VRF) name
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the Junos device by executing the command show routing-options.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the device being managed. - - This module works with connection ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - Tested against JunOS v18.4R1 - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - # Before state - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # route 192.168.16.0/24 next-hop 172.16.1.2; - # } - - - name: Delete provided configuration (default operation is merge) - junipernetworks.junos.junos_static_routes: - config: - - address_families: - - afi: ipv4 - routes: - - dest: 192.168.16.0/24 - next_hop: - - forward_router_address: 172.16.1.2 - state: deleted - - # Task Output - # ----------- - # before: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # commands: - # - '192.168.16.0/24' - # - '' - # after: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - - # After state: - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # } - - # Using merged - - # Before state - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # } - - - name: Merge provided configuration with device configuration (default operation - is merge) - junipernetworks.junos.junos_static_routes: - config: - - address_families: - - afi: ipv4 - routes: - - dest: 192.168.16.0/24 - next_hop: - - forward_router_address: 172.16.1.2 - state: merged - - # Task Output - # ----------- - # before: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # commands: - # - '192.168.16.0/24 - # 172.16.1.2' - # - '' - # after: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # After state: - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # route 192.168.16.0/24 next-hop 172.16.1.2; - # } - - # Using overridden - - # Before state - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # route 192.168.16.0/24 next-hop 172.16.1.2; - # } - - - name: Override running configuration with provided configuration (default operation - is merge) - junipernetworks.junos.junos_static_routes: - config: - - address_families: - - afi: ipv4 - routes: - - dest: 192.168.16.0/24 - next_hop: - - forward_router_address: 172.16.0.1 - state: overridden - # Task Output: - # ------------ - # before: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # commands: - # - >- - # 192.168.47.0/24192.168.16.0/24192.168.16.0/24172.16.0.1 - # - '' - # after: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.0.1 - - # After state: - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.16.0/24 next-hop 172.16.0.1; - # } - - # Using replaced - - # Before state - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 172.16.1.2; - # route 192.168.16.0/24 next-hop 172.16.1.2; - # } - - - name: Replace provided configuration with device configuration (default operation - is merge) - junipernetworks.junos.junos_static_routes: - config: - - address_families: - - afi: ipv4 - routes: - - dest: 192.168.47.0/24 - next_hop: - - forward_router_address: 10.200.16.2 - state: replaced - - # Task Output: - # ------------ - # before: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # commands: - # - >- - # 192.168.47.0/24192.168.47.0/2410.200.16.2 - # - '' - # after: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 10.200.16.2 - - # After state: - # ------------ - # - # admin# show routing-options - # static { - # route 192.168.47.0/24 next-hop 10.200.16.2; - # route 192.168.16.0/24 next-hop 172.16.1.2; - # } - - # Using gathered to gather static route facts from the device - # Before state - # ------------ - # admin# show routing-options - # static { - # route 192.168.16.0/24 next-hop 172.16.1.2; - # route 192.168.47.0/24 next-hop 10.200.16.2; - # } - - name: Gather static routes facts from the device using junos_static_routes module - junipernetworks.junos.junos_static_routes: - state: gathered - - # Task output: - # ------------ - # gathered: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: 172.16.1.2 - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 10.200.16.2 - - # Using rendered - - - name: Render platform specific commands (without connecting to the device) - junipernetworks.junos.junos_static_routes: - config: - - address_families: - - afi: ipv4 - routes: - - dest: 192.168.16.0/24 - next_hop: - - forward_router_address: 172.16.1.2 - state: rendered - - # Task output: - # ------------ - # rendered: - # - '192.168.16.0/24 - # 172.16.1.2' - - # Using parsed - - # parsed.cfg - # ------------ - # - # - # - # 18.4R1-S2.4 - # - # - # - # 192.168.16.0/24 - # 172.16.1.2 - # 172.16.1.3 - # - # - # 192.168.47.0/24 - # 10.200.16.2 - # - # - # - # - # - - - name: Parsed running config (without connecting to the device) - junipernetworks.junos.junos_static_routes: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # - address_families: - # - afi: ipv4 - # routes: - # - dest: 192.168.16.0/24 - # next_hop: - # - forward_router_address: '[''172.16.1.2'', ''172.16.1.3'']' - # - dest: 192.168.47.0/24 - # next_hop: - # - forward_router_address: 10.200.16.2 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- string -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- string -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['command 1', 'command 2', 'command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['<nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniel Mellado (@dmellado) diff --git a/docs/junipernetworks.junos.junos_user_module.rst b/docs/junipernetworks.junos.junos_user_module.rst deleted file mode 100644 index 256362cf..00000000 --- a/docs/junipernetworks.junos.junos_user_module.rst +++ /dev/null @@ -1,447 +0,0 @@ -.. _junipernetworks.junos.junos_user_module: - - -******************************** -junipernetworks.junos.junos_user -******************************** - -**Manage local user accounts on Juniper JUNOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages locally configured user accounts on remote network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- ncclient (>=v0.5.2) - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- active - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Specifies whether or not the configuration is active or deactivated
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
The aggregate argument defines a list of users to be configured on the remote device. The list of users will be compared against the current users and only changes will be added or removed from the device configuration. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
-
-
- active - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether or not the configuration is active or deactivated
-
-
- encrypted_password - -
- string -
- 		- -
The encrypted_password argument set already hashed password for the user account on the remote system.
-
-
- full_name - -
- string -
- 		- -
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
-
-
- name - -
- string - / required -
- 		- -
The name argument defines the username of the user to be created on the system. This argument must follow appropriate usernaming conventions for the target device running JUNOS. This argument is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the users definition absolute. It will remove any previously configured users on the device with the exception of the current defined set of aggregate.
-
-
- role - -
- string -
- 		-
    Choices: -
  • operator
    • -
  • read-only
    • -
  • super-user
    • -
  • unauthorized
    • -
- 		-
The role argument defines the role of the user account on the remote system. User accounts can have more than one role configured.
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the public SSH key to be configured for the user account on the remote system. This argument must be a valid SSH key
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
The state argument configures the state of the user definitions as it relates to the device operational configuration. When set to present, the user should be configured in the device active configuration and when set to absent the user should not be in the device active configuration
-
-
- encrypted_password - -
- string -
- 		- -
The encrypted_password argument set already hashed password for the user account on the remote system.
-
-
- full_name - -
- string -
- 		- -
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
-
-
- name - -
- string -
- 		- -
The name argument defines the username of the user to be created on the system. This argument must follow appropriate usernaming conventions for the target device running JUNOS. This argument is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the users definition absolute. It will remove any previously configured users on the device with the exception of the current defined set of aggregate.
-
-
- role - -
- string -
- 		-
    Choices: -
  • operator
    • -
  • read-only
    • -
  • super-user
    • -
  • unauthorized
    • -
- 		-
The role argument defines the role of the user account on the remote system. User accounts can have more than one role configured.
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the public SSH key to be configured for the user account on the remote system. This argument must be a valid SSH key
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument configures the state of the user definitions as it relates to the device operational configuration. When set to present, the user should be configured in the device active configuration and when set to absent the user should not be in the device active configuration
-
-
- - -Notes ------ - -.. note:: - - This module requires the netconf system service be enabled on the remote device being managed. - - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. - - Recommended connection is ``netconf``. See `the Junos OS Platform Options <../network/user_guide/platform_junos.html>`_. - - This module also works with ``local`` connections for legacy playbooks. - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. - - - -Examples --------- - -.. code-block:: yaml - - - name: create new user account - junipernetworks.junos.junos_user: - name: ansible - role: super-user - sshkey: "{{ lookup('file', '~/.ssh/ansible.pub') }}" - state: present - - - name: remove a user account - junipernetworks.junos.junos_user: - name: ansible - state: absent - - - name: remove all user accounts except ansible - junipernetworks.junos.junos_user: - aggregate: - - name: ansible - purge: true - - - name: set user password - junipernetworks.junos.junos_user: - name: ansible - role: super-user - encrypted_password: "{{ 'my-password' | password_hash('sha512') }}" - state: present - - - name: Create list of users - junipernetworks.junos.junos_user: - aggregate: - - {name: test_user1, full_name: test_user2, role: operator, state: present} - - {name: test_user2, full_name: test_user2, role: read-only, state: present} - - - name: Delete list of users - junipernetworks.junos.junos_user: - aggregate: - - {name: test_user1, full_name: test_user2, role: operator, state: absent} - - {name: test_user2, full_name: test_user2, role: read-only, state: absent} - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- diff.prepared - -
- string -
- 		when configuration is changed and diff option is enabled. -
Configuration difference before and after applying change.
-
-
Sample:
-
[edit system login] + user test-user { + uid 2005; + class read-only; + }
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip)