Skip to content

Commit

Permalink
[ignore] Fixed notes section and added seealso
Browse files Browse the repository at this point in the history
  • Loading branch information
samiib committed Dec 19, 2024
1 parent 94291f4 commit 7a96323
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
22 changes: 12 additions & 10 deletions plugins/modules/mso_schema_template_anp_epg_annotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,14 @@
default: present
extends_documentation_fragment: cisco.mso.modules
notes:
- The O(schema) and O(template) must exist before using this module in your playbook.
Use M(cisco.mso.mso_schema_template) to create the schema template.
- The O(anp) must exist before using this module in your playbook.
- The O(schema), O(template), O(anp) and O(epg) must exist before using this module in your playbook.
Use M(cisco.mso.mso_schema_template) to create the schema and template.
Use M(cisco.mso.mso_schema_template_anp) to create the ANP.
- The O(epg) must exist before using this module in your playbook.
Use M(cisco.mso.mso_schema_template_anp_epg) to create the EPG.
seealso:
- module: cisco.mso.mso_schema_template
- module: cisco.mso.mso_schema_template_anp
- module: cisco.mso.mso_schema_template_anp_epg
"""

EXAMPLES = r"""
Expand All @@ -78,8 +80,8 @@
template: Template 1
anp: ANP 1
epg: EPG 1
annotation_key: "annotation_key_1"
annotation_value: "annotation_value_1"
annotation_key: annotation_key_1
annotation_value: annotation_value_1
state: present
- name: Update an annotation with value
Expand All @@ -91,8 +93,8 @@
template: Template 1
anp: ANP 1
epg: EPG 1
annotation_key: "annotation_key_1_updated"
annotation_value: "annotation_value_1"
annotation_key: annotation_key_1_updated
annotation_value: annotation_value_1
state: present
- name: Query a specific annotation with key
Expand All @@ -104,7 +106,7 @@
template: Template 1
anp: ANP 1
epg: EPG 1
annotation_key: "annotation_key_1_updated"
annotation_key: annotation_key_1_updated
state: query
register: query_one
Expand All @@ -129,7 +131,7 @@
template: Template 1
anp: ANP 1
epg: EPG 1
annotation_key: "annotation_key_1_updated"
annotation_key: annotation_key_1_updated
state: absent
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@
- name: Create an EPG annotation (check mode)
cisco.mso.mso_schema_template_anp_epg_annotation: &add_annotation_1
<<: *ans_test_epg_present
annotation_key: "annotation_key_1"
annotation_value: "annotation_value_1"
annotation_key: annotation_key_1
annotation_value: annotation_value_1
check_mode: true
register: cm_add_epg_annotation

Expand Down Expand Up @@ -148,8 +148,8 @@
- name: Create another EPG annotation
cisco.mso.mso_schema_template_anp_epg_annotation:
<<: *add_annotation_1
annotation_key: "annotation_key_2"
annotation_value: "annotation_value_2"
annotation_key: annotation_key_2
annotation_value: annotation_value_2

- name: Query all EPG annotations
cisco.mso.mso_schema_template_anp_epg_annotation: &query_all
Expand All @@ -160,7 +160,7 @@
- name: Query one EPG annotation
cisco.mso.mso_schema_template_anp_epg_annotation: &query_one
<<: *ans_test_epg_present
annotation_key: "annotation_key_2"
annotation_key: annotation_key_2
state: query
ignore_errors: true
register: query_one
Expand Down Expand Up @@ -209,7 +209,7 @@
- name: Delete the remaining EPG annotation
cisco.mso.mso_schema_template_anp_epg_annotation:
<<: *delete_annotation_1
annotation_key: "annotation_key_2"
annotation_key: annotation_key_2

- name: Query all EPG annotations when none exist
cisco.mso.mso_schema_template_anp_epg_annotation:
Expand All @@ -219,7 +219,7 @@
- name: Query an EPG annotation that does not exist
cisco.mso.mso_schema_template_anp_epg_annotation:
<<: *query_one
annotation_key: "annotation_key_3"
annotation_key: annotation_key_3
register: query_one_none

- name: Create an EPG annotation when EPG does not exist
Expand Down

0 comments on commit 7a96323

Please sign in to comment.