Skip to content

Commit 08b9360

Browse files
gmicollhercot
authored andcommitted
[ignore] Adjust Documentation modifications for nd_compliance modules.
1 parent 868f7aa commit 08b9360

7 files changed

+19
-18
lines changed

plugins/doc_fragments/ndi_compliance_base.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,12 @@ class ModuleDocFragment(object):
3131
description:
3232
- Enable the compliance requirement.
3333
type: bool
34-
sites:
34+
fabrics:
3535
description:
36-
- The names of the sites.
36+
- The names of the fabrics.
3737
type: list
3838
elements: str
39+
aliases: [ sites ]
3940
state:
4041
description:
4142
- Use C(present) or C(absent) for adding or removing.

plugins/modules/nd_compliance_analysis.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@
3030
aliases: [ fab_name, ig_name ]
3131
fabric:
3232
description:
33-
- The names of the fabric.
33+
- The name of the fabric.
3434
type: str
3535
required: true
3636
aliases: [site, site_name, fabric_name ]
3737
snapshot_id:
3838
description:
39-
- The snapshot ID.
40-
- When the O(snapshot_id) is not provided it will retrieve the latest known snapshot ID.
39+
- The snapshot/epoch ID.
40+
- When the O(snapshot_id) is not provided it will retrieve the latest known snapshot/epoch ID.
4141
type: str
4242
aliases: [ epoch_id ]
4343
extends_documentation_fragment:
@@ -73,7 +73,7 @@ def main():
7373
argument_spec.update(
7474
insights_group=dict(type="str", default="default", aliases=["fab_name", "ig_name"]),
7575
fabric=dict(type="str", required=True, aliases=["site", "site_name", "fabric_name"]),
76-
snapshot_id=dict(type="str", alaises=["epoch_id"]),
76+
snapshot_id=dict(type="str", aliases=["epoch_id"]),
7777
)
7878

7979
module = AnsibleModule(

plugins/modules/nd_compliance_requirement_communication.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,8 +324,8 @@
324324
insights_group: igName
325325
name: complianceRequirementName
326326
fabrics:
327-
- siteName1
328-
- siteName2
327+
- fabricName1
328+
- fabricName2
329329
enabled: false
330330
type: may
331331
from_object:

plugins/modules/nd_compliance_requirement_config_import.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@
5555
insights_group: igName
5656
name: complianceRequirementName
5757
fabrics:
58-
- siteName1
59-
- siteName2
58+
- fabricName1
59+
- fabricName2
6060
enabled: false
6161
file: fileName.json
6262
state: present

plugins/modules/nd_compliance_requirement_config_manual.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@
171171
insights_group: igName
172172
name: complianceRequirementName
173173
fabrics:
174-
- siteName1
175-
- siteName2
174+
- fabricName1
175+
- fabricName2
176176
enabled: false
177177
object:
178178
type: epg

plugins/modules/nd_compliance_requirement_config_snapshot.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
aliases: [ site, site_name, baseline_site, fabric, fabric_name ]
2929
snapshot_id:
3030
description:
31-
- The snapshot ID.
32-
- When O(snapshot_id) is not provided it will retrieve the latest known snapshot ID.
31+
- The snapshot/epoch ID.
32+
- When O(snapshot_id) is not provided it will retrieve the latest known snapshot/epoch ID.
3333
type: str
3434
aliases: [ epoch_id ]
3535
allow_new_configuration_objects:
@@ -62,8 +62,8 @@
6262
insights_group: igName
6363
name: complianceRequirementName
6464
fabrics:
65-
- siteName1
66-
- siteName2
65+
- fabricName1
66+
- fabricName2
6767
enabled: false
6868
snapshot_id: 0e5604f9-373a123c-b535-33fc-8d11-672d08f65fd1
6969
state: present

plugins/modules/nd_compliance_requirement_config_template.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@
5555
insights_group: igName
5656
name: complianceRequirementName
5757
fabrics:
58-
- siteName1
59-
- siteName2
58+
- fabricName1
59+
- fabricName2
6060
enabled: false
6161
file: fileName.json
6262
state: present

0 commit comments

Comments
 (0)