From ee6ea4de3b5baae4e4494b79c3999fbceeb69de0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 6 Jun 2024 15:09:54 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/cisco.ios.ios_acls_module.rst | 19 - ...isco.ios.ios_bgp_address_family_module.rst | 19 - docs/cisco.ios.ios_bgp_global_module.rst | 1147 ++--------------- docs/cisco.ios.ios_linkagg_module.rst | 327 ----- docs/cisco.ios.ios_lldp_module.rst | 138 -- 5 files changed, 78 insertions(+), 1572 deletions(-) delete mode 100644 docs/cisco.ios.ios_linkagg_module.rst delete mode 100644 docs/cisco.ios.ios_lldp_module.rst diff --git a/docs/cisco.ios.ios_acls_module.rst b/docs/cisco.ios.ios_acls_module.rst index bb0328d87..b098bcd4a 100644 --- a/docs/cisco.ios.ios_acls_module.rst +++ b/docs/cisco.ios.ios_acls_module.rst @@ -424,25 +424,6 @@ Parameters
Evaluate an access list
- - - - - -
- fragments - -
- string -
- - - - -
Check non-initial fragments.
-
This option is DEPRECATED and is replaced with enable_fragments which accepts bool as input this attribute will be removed after 2024-01-01.
- - diff --git a/docs/cisco.ios.ios_bgp_address_family_module.rst b/docs/cisco.ios.ios_bgp_address_family_module.rst index 268217811..83580423d 100644 --- a/docs/cisco.ios.ios_bgp_address_family_module.rst +++ b/docs/cisco.ios.ios_bgp_address_family_module.rst @@ -3512,25 +3512,6 @@ Parameters - - - - - -
- password - -
- string -
- - - - -
Set a password
-
This option is DEPRECATED and is replaced with password_options which accepts dict as input, this attribute will be removed after 2024-06-01.
- - diff --git a/docs/cisco.ios.ios_bgp_global_module.rst b/docs/cisco.ios.ios_bgp_global_module.rst index 77eb908c5..f3ec41e59 100644 --- a/docs/cisco.ios.ios_bgp_global_module.rst +++ b/docs/cisco.ios.ios_bgp_global_module.rst @@ -50,172 +50,6 @@ Parameters - -
- aggregate_address - -
- dictionary -
- - - - -
Configure BGP aggregate entry
-
This option is DEPRECATED and is replaced with aggregate_addresses which accepts list of dict as input, this attribute will be removed after 2024-06-01.
- - - - - - -
- address - -
- string -
- - - - -
Specify aggregate address
- - - - - - -
- advertise_map - -
- string -
- - - - -
Set condition to advertise attribute
- - - - - - -
- as_confed_set - -
- boolean -
- - - - - -
Generate AS confed set path information
- - - - - - -
- as_set - -
- boolean -
- - - - - -
Generate AS set path information
- - - - - - -
- attribute_map - -
- string -
- - - - -
Set attributes of aggregate
- - - - - - -
- netmask - -
- string -
- - - - -
Specify aggregate mask
- - - - - - -
- summary_only - -
- boolean -
- - - - - -
Filter more specific routes from updates
- - - - - - -
- suppress_map - -
- string -
- - - - -
Conditionally filter more specific routes from updates
- - - - -
aggregate_addresses @@ -596,186 +430,17 @@ Parameters -
Select group-best path
- - - - - - - - -
- send - -
- boolean -
- - - - - -
Send additional paths to neighbors
- - - - - - - -
- advertise_best_external - -
- boolean -
- - - - - -
Advertise best external path to internal peers
- - - - - - -
- aggregate_timer - -
- integer -
- - - - -
Configure Aggregation Timer
-
Please refer vendor documentation for valid values
- - - - - - -
- always_compare_med - -
- boolean -
- - - - - -
Allow comparing MED from different neighbors
- - - - - - -
- asnotation - -
- boolean -
- - - - - -
Change the default as plain notation
-
asdot notation
- - - - - - -
- bestpath - -
- list - / elements=dictionary -
- - - - -
Change the default bestpath selection
-
This option is DEPRECATED and replaced with bestpath_options of type dict, this attribute will be removed after 2024-06-01.
- - - - - - - -
- aigp - -
- boolean -
- - - - - -
if both paths doesn't have aigp ignore on bestpath comparison
-
ignore
- - - - - - - -
- compare_routerid - -
- boolean -
- - - - - -
Compare router-id for identical EBGP paths
+
Select group-best path
+
- cost_community + send
boolean @@ -788,16 +453,16 @@ Parameters -
cost community
+
Send additional paths to neighbors
+ - - +
- igp_metric + advertise_best_external
boolean @@ -810,36 +475,33 @@ Parameters -
igp metric
-
Ignore igp metric in bestpath selection
+
Advertise best external path to internal peers
- - +
- med + aggregate_timer
- dictionary + integer
-
MED attribute
+
Configure Aggregation Timer
+
Please refer vendor documentation for valid values
- - - + - +
- confed + always_compare_med
boolean @@ -852,17 +514,15 @@ Parameters -
Compare MED among confederation paths
+
Allow comparing MED from different neighbors
- - - +
- missing_as_worst + asnotation
boolean @@ -875,11 +535,10 @@ Parameters -
Treat missing MED as the least preferred one
+
Change the default as plain notation
+
asdot notation
- - @@ -1929,83 +1588,6 @@ Parameters - - - - -
- inject_map - -
- dictionary -
- - - - -
Routemap which specifies prefixes to inject
-
This option is DEPRECATED and is updated with inject_maps which is a list of dict, this attribute will be removed after 2024-06-01.
- - - - - - - -
- copy_attributes - -
- boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Copy attributes from aggregate
- - - - - - - -
- exist_map_name - -
- string -
- - - - -
route-map name
- - - - - - - -
- name - -
- string -
- - - - -
route-map name
- - - @@ -2157,46 +1739,6 @@ Parameters
IPv6 subnet range(X:X:X:X::X/<0-128>)
- - - - - - -
- ipv4_with_subnet - -
- string -
- - - - -
IPv4 subnet range(A.B.C.D/nn)
-
This option is DEPRECATED and is updated with host_with_subnet which is a common attribute for address, this attribute will be removed after 2024-06-01.
- - - - - - - - -
- ipv6_with_subnet - -
- string -
- - - - -
IPv6 subnet range(X:X:X:X::X/<0-128>)
-
This option is DEPRECATED and is updated with host_with_subnet which is a common attribute for address attribute will be removed after 2024-06-01.
- - @@ -2307,107 +1849,7 @@ Parameters -
Nexthop tracking commands
- - - - - - - -
- route_map - -
- string -
- - - - -
Route map for valid nexthops
- - - - - - - -
- trigger - -
- dictionary -
- - - - -
nexthop trackings
- - - - - - - - -
- delay - -
- integer -
- - - - -
Set the delay to trigger nexthop tracking
-
Please refer vendor documentation for valid values
- - - - - - - - -
- enable - -
- boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enable nexthop tracking
- - - - - - - - -
- nopeerup_delay - -
- list - / elements=dictionary -
- - - - -
Set how long BGP will wait for the first peer to come up before beginning the update delay or graceful restart timers (in seconds)
-
This option is DEPRECATED and is replaced with nopeerup_delay_options which is of type dict, this attribute will be removed after 2024-06-01.
+
Nexthop tracking commands
@@ -2416,17 +1858,16 @@ Parameters
- cold_boot + route_map
- integer + string
-
How long to wait for the first peer to come up upon a cold boot
-
Please refer vendor documentation for valid values
+
Route map for valid nexthops
@@ -2435,26 +1876,26 @@ Parameters
- nsf_switchover + trigger
- integer + dictionary
-
How long to wait for the first peer, post NSF switchover
-
Please refer vendor documentation for valid values
+
nexthop trackings
- + - + +
- post_boot + delay
integer @@ -2463,7 +1904,7 @@ Parameters -
How long to wait for the first peer to come up once the system is already booted and all peers go down
+
Set the delay to trigger nexthop tracking
Please refer vendor documentation for valid values
@@ -2471,22 +1912,27 @@ Parameters - + +
- user_initiated + enable
- integer + boolean
+
    Choices: +
  • no
    • +
  • yes
    • +
-
How long to wait for the first peer, post a manual clear of BGP peers by the admin user
-
Please refer vendor documentation for valid values
+
Enable nexthop tracking
+ @@ -3683,100 +3129,6 @@ Parameters - - - -
- distribute_list - -
- dictionary -
- - - - -
Filter networks in routing updates
-
This option is DEPRECATED and is replaced with distributes which is of type list of dict, this attribute will be removed after 2024-06-01.
- - - - - - -
- acl - -
- string -
- - - - -
IP access list number/name
- - - - - - -
- in - -
- boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Filter incoming routing updates
- - - - - - -
- interface - -
- string -
- - - - -
interface details
- - - - - - -
- out - -
- boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Filter outgoing routing updates
- - - @@ -4164,24 +3516,6 @@ Parameters - - - - -
- address - -
- string -
- - - - -
Neighbor address (A.B.C.D)
-
This option is DEPRECATED and replaced with neighbor_address, this attribute will be removed after 2024-06-01.
- - @@ -5445,24 +4779,6 @@ Parameters
Inherit a peer-session template and Template name
- - - - -
- ipv6_adddress - -
- string -
- - - - -
Neighbor ipv6 address (X:X:X:X::X)
-
This option is DEPRECATED and replaced with neighbor_address, this attribute will be removed after 2024-06-01.
- - @@ -5909,24 +5225,6 @@ Parameters - - - - -
- password - -
- string -
- - - - -
Set a password
-
This option is DEPRECATED and is replaced with password_options which accepts dict as input, this attribute will be removed after 2024-06-01.
- - @@ -6211,167 +5509,83 @@ Parameters
- start - -
- integer -
- - - - -
path attribute range start value
-
Please refer vendor documentation for valid values
- - - - - - - - - -
- type - -
- integer -
- - - - -
path attribute type
-
Please refer vendor documentation for valid values
- - - - - - - - -
- peer_group - -
- string -
- - - - -
Member of the peer-group
- - - - - - -
- remote_as - -
- string -
- - - - -
Specify a BGP neighbor
-
AS of remote neighbor
- - - - - - -
- remove_private_as + start
- dictionary + integer
-
Remove private AS number from outbound updates
+
path attribute range start value
+
Please refer vendor documentation for valid values
- + + - + +
- all + type
- boolean + integer
-
    Choices: -
  • no
    • -
  • yes
    • -
-
Remove all private AS numbers
+
path attribute type
+
Please refer vendor documentation for valid values
+ + - - +
- replace_as + peer_group
- boolean + string
-
    Choices: -
  • no
    • -
  • yes
    • -
-
Replace all private AS numbers with local AS
+
Member of the peer-group
- - +
- set + remote_as
- boolean + string
-
    Choices: -
  • no
    • -
  • yes
    • -
-
Remove private AS number
+
Specify a BGP neighbor
+
AS of remote neighbor
-
- route_map + remove_private_as
dictionary @@ -6380,8 +5594,7 @@ Parameters -
Apply route map to neighbor
-
This option is DEPRECATED and is replaced with route_maps which accepts list of dict as input, this attribute will be removed after 2024-06-01.
+
Remove private AS number from outbound updates
@@ -6390,7 +5603,7 @@ Parameters
- in + all
boolean @@ -6403,7 +5616,7 @@ Parameters -
Apply map to incoming routes
+
Remove all private AS numbers
@@ -6412,13 +5625,17 @@ Parameters
- name + replace_as
- string + boolean
+
    Choices: +
  • no
    • +
  • yes
    • +
Replace all private AS numbers with local AS
@@ -6430,7 +5647,7 @@ Parameters
- out + set
boolean @@ -6443,7 +5660,7 @@ Parameters -
Apply map to outbound routes
+
Remove private AS number
@@ -7134,24 +6351,6 @@ Parameters
Allow inbound soft reconfiguration for this neighbor
- - - - -
- tag - -
- string -
- - - - -
Neighbor tag
-
This option is DEPRECATED and replaced with neighbor_address, this attribute will be removed after 2024-06-01.
- - @@ -9072,196 +8271,6 @@ Parameters - - - -
- route_server_context - -
- dictionary -
- - - - -
Enter route server context command mode
-
This option is DEPRECATED as it is out of scope of the module, this attribute will be removed after 2024-06-01.
- - - - - - -
- address_family - -
- dictionary -
- - - - -
Enter address family command mode
- - - - - - - -
- afi - -
- string -
- - -
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- - -
Address family
- - - - - - - -
- import_map - -
- string -
- - - - -
Import matching routes using a route map
-
Name of route map
- - - - - - - -
- modifier - -
- string -
- - -
    Choices: -
  • multicast
    • -
  • unicast
    • -
- - -
Address Family modifier
- - - - - - - -
- description - -
- string -
- - - - -
Textual description of the router server context
- - - - - - -
- name - -
- string -
- - - - -
Name of route server context
- - - - - - -
- scope - -
- dictionary -
- - - - -
Enter scope command mode
-
This option is DEPRECATED as is not valid within the scope of module, this attribute will be removed after 2024-06-01.
- - - - - - -
- global - -
- boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Global scope
- - - - - - -
- vrf - -
- string -
- - - - -
VRF scope
-
VPN Routing/Forwarding instance name
- - - diff --git a/docs/cisco.ios.ios_linkagg_module.rst b/docs/cisco.ios.ios_linkagg_module.rst deleted file mode 100644 index 1a3c30505..000000000 --- a/docs/cisco.ios.ios_linkagg_module.rst +++ /dev/null @@ -1,327 +0,0 @@ -.. _cisco.ios.ios_linkagg_module: - - -********************* -cisco.ios.ios_linkagg -********************* - -**Module to configure link aggregation groups.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-06-01 -:Why: Updated modules released with more functionality. -:Alternative: ios_lag_interfaces - - - -Synopsis --------- -- This module provides declarative management of link aggregation groups on Cisco IOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of link aggregation definitions.
-
-
- group - -
- string - / required -
- 		- -
Channel-group number for the port-channel Link aggregation group. Range 1-255.
-
-
- members - -
- list - / elements=string -
- 		- -
List of members of the link aggregation group.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • active
    • -
  • on
    • -
  • passive
    • -
  • auto
    • -
  • desirable
    • -
- 		-
Mode of the link aggregation group.
-
On mode has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
State of the link aggregation group.
-
-
- group - -
- integer -
- 		- -
Channel-group number for the port-channel Link aggregation group. Range 1-255.
-
-
- members - -
- list - / elements=string -
- 		- -
List of members of the link aggregation group.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • active
    • -
  • on
    • -
  • passive
    • -
  • auto
    • -
  • desirable
    • -
- 		-
Mode of the link aggregation group.
-
On mode has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge links not defined in the aggregate parameter.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the link aggregation group.
-
-
- - -Notes ------ - -.. note:: - - Tested against IOS 15.2 - - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Create link aggregation group - cisco.ios.ios_linkagg: - group: 10 - state: present - - - name: Delete link aggregation group - cisco.ios.ios_linkagg: - group: 10 - state: absent - - - name: Set link aggregation group to members - cisco.ios.ios_linkagg: - group: 200 - mode: active - members: - - GigabitEthernet0/0 - - GigabitEthernet0/1 - - - name: Remove link aggregation group from GigabitEthernet0/0 - cisco.ios.ios_linkagg: - group: 200 - mode: active - members: - - GigabitEthernet0/1 - - - name: Create aggregate of linkagg definitions - cisco.ios.ios_linkagg: - aggregate: - - { group: 3, mode: "on", members: [GigabitEthernet0/1] } - - { group: 100, mode: passive, members: [GigabitEthernet0/2] } - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['interface port-channel 30', 'interface GigabitEthernet0/3', 'channel-group 30 mode on', 'no interface port-channel 30']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.ios.ios_lldp_module.rst b/docs/cisco.ios.ios_lldp_module.rst deleted file mode 100644 index 5ccf0b4b3..000000000 --- a/docs/cisco.ios.ios_lldp_module.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. _cisco.ios.ios_lldp_module: - - -****************** -cisco.ios.ios_lldp -****************** - -**(deprecated, removed after 2024-06-01) Manage LLDP configuration on Cisco IOS network devices.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-06-01 -:Why: Newer and updated modules released with more functionality. -:Alternative: ios_lldp_global - - - -Synopsis --------- -- This module provides declarative management of LLDP service on Cisco IOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • enabled
    • -
  • disabled
    • -
- 		-
State of the LLDP configuration. If value is present lldp will be enabled else if it is absent it will be disabled.
-
-
- - -Notes ------ - -.. note:: - - Tested against IOS 15.2 - - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable LLDP service - cisco.ios.ios_lldp: - state: present - - - name: Disable LLDP service - cisco.ios.ios_lldp: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['lldp run']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn)