Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for SONiC Ansible collection #394

Merged
merged 8 commits into from
Jun 12, 2024
Merged

Update documentation for SONiC Ansible collection #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0f14b59
Update version added and remove extraneous facts reports
stalabi1 Jun 10, 2024
88f90ea
Add fragment
stalabi1 Jun 10, 2024
b0a5328
Update documentation
stalabi1 Jun 11, 2024
24edd36
Update 394-update-version-remove-facts-reports.yaml
stalabi1 Jun 11, 2024
def684b
Resolve sanity error
stalabi1 Jun 11, 2024
37a1422
Update plugins/modules/sonic_l2_acls.py
stalabi1 Jun 12, 2024
0d18a16
Update plugins/modules/sonic_dhcp_snooping.py
stalabi1 Jun 12, 2024
58e2808
Update changelogs/fragments/394-update-version-remove-facts-reports.yaml
stalabi1 Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/394-update-version-remove-facts-reports.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- Update module docummentation and remove extraneous regression facts reports (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/394).
14 changes: 7 additions & 7 deletions plugins/modules/sonic_acl_interfaces.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2022 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -335,26 +335,26 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after(generated):
description: The generated configuration model invocation.
description: The generated configuration module invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/sonic_bgp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# © Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
# © Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -506,19 +506,19 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/sonic_bgp_af.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# © Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
# © Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -869,19 +869,19 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned always in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/sonic_bgp_as_paths.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -256,19 +256,19 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/sonic_bgp_communities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -355,19 +355,19 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration that is returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration that is returned is always in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands that are pushed to the remote device.
returned: always
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/sonic_bgp_ext_communities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -336,19 +336,19 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
14 changes: 7 additions & 7 deletions plugins/modules/sonic_bgp_neighbors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -1069,26 +1069,26 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after(generated):
description: The generated configuration model invocation.
description: The generated configuration module invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
14 changes: 7 additions & 7 deletions plugins/modules/sonic_bgp_neighbors_af.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2019 Red Hat
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -510,26 +510,26 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned is always in the same format
of the parameters above.
as the parameters above.
after(generated):
description: The generated configuration model invocation.
description: The generated configuration module invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/sonic_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: (c) 2020, Peter Sprygada <[email protected]>
# Copyright: (c) 2020, Dell Inc.
# Copyright: (c) 2024, Peter Sprygada <[email protected]>
# Copyright: (c) 2024, Dell Inc.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/sonic_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/python
#
# (c) 2015 Peter Sprygada, <[email protected]>
# Copyright (c) 2020 Dell Inc.
# (c) 2024 Peter Sprygada, <[email protected]>
# Copyright (c) 2024 Dell Inc.
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down
14 changes: 7 additions & 7 deletions plugins/modules/sonic_dhcp_relay.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2022 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -741,26 +741,26 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after(generated):
description: The generated configuration model invocation.
description: The generated configuration module invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
14 changes: 7 additions & 7 deletions plugins/modules/sonic_dhcp_snooping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
# Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Expand Down Expand Up @@ -457,26 +457,26 @@
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
description: The configuration prior to the module invocation.
returned: always
type: dict
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after:
description: The resulting configuration model invocation.
description: The resulting configuration module invocation.
returned: when changed
type: dict
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
after(generated):
description: The generated configuration model invocation.
description: The generated configuration module invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
as the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
Expand Down
Loading
Loading