1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Minor fixes (#25059)

1) Examples: Remove double space between "option:" and "value"
2) Documentation: Fix rendering usses
3) Documentation: Remove `required: true` to match argspec
This commit is contained in:
John R Barker 2017-05-26 15:17:08 +01:00 committed by GitHub
parent ce584571e8
commit 3740ad2828
27 changed files with 287 additions and 291 deletions

View file

@ -116,34 +116,34 @@ EXAMPLES = '''
- name: "Radius authentication Server Basic settings" - name: "Radius authentication Server Basic settings"
ce_aaa_server: ce_aaa_server:
state: present state: present
authen_scheme_name: test1 authen_scheme_name: test1
first_authen_mode: radius first_authen_mode: radius
radius_server_group: test2 radius_server_group: test2
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo radius authentication Server Basic settings" - name: "Undo radius authentication Server Basic settings"
ce_aaa_server: ce_aaa_server:
state: absent state: absent
authen_scheme_name: test1 authen_scheme_name: test1
first_authen_mode: radius first_authen_mode: radius
radius_server_group: test2 radius_server_group: test2
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Hwtacacs accounting Server Basic settings" - name: "Hwtacacs accounting Server Basic settings"
ce_aaa_server: ce_aaa_server:
state: present state: present
acct_scheme_name: test1 acct_scheme_name: test1
accounting_mode: hwtacacs accounting_mode: hwtacacs
hwtacas_template: test2 hwtacas_template: test2
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo hwtacacs accounting Server Basic settings" - name: "Undo hwtacacs accounting Server Basic settings"
ce_aaa_server: ce_aaa_server:
state: absent state: absent
acct_scheme_name: test1 acct_scheme_name: test1
accounting_mode: hwtacacs accounting_mode: hwtacacs
hwtacas_template: test2 hwtacas_template: test2
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -185,56 +185,56 @@ EXAMPLES = '''
- name: "Config local user when use local scheme" - name: "Config local user when use local scheme"
ce_aaa_server_host: ce_aaa_server_host:
state: present state: present
local_user_name: user1 local_user_name: user1
local_password: 123456 local_password: 123456
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo local user when use local scheme" - name: "Undo local user when use local scheme"
ce_aaa_server_host: ce_aaa_server_host:
state: absent state: absent
local_user_name: user1 local_user_name: user1
local_password: 123456 local_password: 123456
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config radius server ip" - name: "Config radius server ip"
ce_aaa_server_host: ce_aaa_server_host:
state: present state: present
radius_group_name: group1 radius_group_name: group1
raduis_server_type: Authentication raduis_server_type: Authentication
radius_server_ip: 10.1.10.1 radius_server_ip: 10.1.10.1
radius_server_port: 2000 radius_server_port: 2000
radius_server_mode: Primary-server radius_server_mode: Primary-server
radius_vpn_name: _public_ radius_vpn_name: _public_
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo radius server ip" - name: "Undo radius server ip"
ce_aaa_server_host: ce_aaa_server_host:
state: absent state: absent
radius_group_name: group1 radius_group_name: group1
raduis_server_type: Authentication raduis_server_type: Authentication
radius_server_ip: 10.1.10.1 radius_server_ip: 10.1.10.1
radius_server_port: 2000 radius_server_port: 2000
radius_server_mode: Primary-server radius_server_mode: Primary-server
radius_vpn_name: _public_ radius_vpn_name: _public_
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config hwtacacs server ip" - name: "Config hwtacacs server ip"
ce_aaa_server_host: ce_aaa_server_host:
state: present state: present
hwtacacs_template: template hwtacacs_template: template
hwtacacs_server_ip: 10.10.10.10 hwtacacs_server_ip: 10.10.10.10
hwtacacs_server_type: Authorization hwtacacs_server_type: Authorization
hwtacacs_vpn_name: _public_ hwtacacs_vpn_name: _public_
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo hwtacacs server ip" - name: "Undo hwtacacs server ip"
ce_aaa_server_host: ce_aaa_server_host:
state: absent state: absent
hwtacacs_template: template hwtacacs_template: template
hwtacacs_server_ip: 10.10.10.10 hwtacacs_server_ip: 10.10.10.10
hwtacacs_server_type: Authorization hwtacacs_server_type: Authorization
hwtacacs_vpn_name: _public_ hwtacacs_vpn_name: _public_
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -145,40 +145,40 @@ EXAMPLES = '''
- name: "Config ACL" - name: "Config ACL"
ce_acl: ce_acl:
state: present state: present
acl_name: 2200 acl_name: 2200
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo ACL" - name: "Undo ACL"
ce_acl: ce_acl:
state: delete_acl state: delete_acl
acl_name: 2200 acl_name: 2200
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config ACL base rule" - name: "Config ACL base rule"
ce_acl: ce_acl:
state: present state: present
acl_name: 2200 acl_name: 2200
rule_name: test_rule rule_name: test_rule
rule_id: 111 rule_id: 111
rule_action: permit rule_action: permit
source_ip: 10.10.10.10 source_ip: 10.10.10.10
src_mask: 24 src_mask: 24
frag_type: fragment frag_type: fragment
time_range: wdz_acl_time time_range: wdz_acl_time
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "undo ACL base rule" - name: "undo ACL base rule"
ce_acl: ce_acl:
state: absent state: absent
acl_name: 2200 acl_name: 2200
rule_name: test_rule rule_name: test_rule
rule_id: 111 rule_id: 111
rule_action: permit rule_action: permit
source_ip: 10.10.10.10 source_ip: 10.10.10.10
src_mask: 24 src_mask: 24
frag_type: fragment frag_type: fragment
time_range: wdz_acl_time time_range: wdz_acl_time
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -291,40 +291,40 @@ EXAMPLES = '''
- name: "Config ACL" - name: "Config ACL"
ce_acl_advance: ce_acl_advance:
state: present state: present
acl_name: 3200 acl_name: 3200
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo ACL" - name: "Undo ACL"
ce_acl_advance: ce_acl_advance:
state: delete_acl state: delete_acl
acl_name: 3200 acl_name: 3200
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config ACL advance rule" - name: "Config ACL advance rule"
ce_acl_advance: ce_acl_advance:
state: present state: present
acl_name: test acl_name: test
rule_name: test_rule rule_name: test_rule
rule_id: 111 rule_id: 111
rule_action: permit rule_action: permit
protocol: tcp protocol: tcp
source_ip: 10.10.10.10 source_ip: 10.10.10.10
src_mask: 24 src_mask: 24
frag_type: fragment frag_type: fragment
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo ACL advance rule" - name: "Undo ACL advance rule"
ce_acl_advance: ce_acl_advance:
state: absent state: absent
acl_name: test acl_name: test
rule_name: test_rule rule_name: test_rule
rule_id: 111 rule_id: 111
rule_action: permit rule_action: permit
protocol: tcp protocol: tcp
source_ip: 10.10.10.10 source_ip: 10.10.10.10
src_mask: 24 src_mask: 24
frag_type: fragment frag_type: fragment
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -73,18 +73,18 @@ EXAMPLES = '''
- name: "Apply acl to interface" - name: "Apply acl to interface"
ce_acl_interface: ce_acl_interface:
state: present state: present
acl_name: 2000 acl_name: 2000
interface: 40GE1/0/1 interface: 40GE1/0/1
direction: outbound direction: outbound
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo acl from interface" - name: "Undo acl from interface"
ce_acl_interface: ce_acl_interface:
state: absent state: absent
acl_name: 2000 acl_name: 2000
interface: 40GE1/0/1 interface: 40GE1/0/1
direction: outbound direction: outbound
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -205,22 +205,22 @@ EXAMPLES = '''
- name: "Enable BGP" - name: "Enable BGP"
ce_bgp: ce_bgp:
state: present state: present
as_number: 100 as_number: 100
confed_id_number: 250 confed_id_number: 250
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Disable BGP" - name: "Disable BGP"
ce_bgp: ce_bgp:
state: absent state: absent
as_number: 100 as_number: 100
confed_id_number: 250 confed_id_number: 250
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Create confederation peer AS num" - name: "Create confederation peer AS num"
ce_bgp: ce_bgp:
state: present state: present
confed_peer_as_num: 260 confed_peer_as_num: 260
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -418,52 +418,52 @@ EXAMPLES = '''
- name: "Config BGP Address_Family" - name: "Config BGP Address_Family"
ce_bgp_af: ce_bgp_af:
state: present state: present
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo BGP Address_Family" - name: "Undo BGP Address_Family"
ce_bgp_af: ce_bgp_af:
state: absent state: absent
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config import route" - name: "Config import route"
ce_bgp_af: ce_bgp_af:
state: present state: present
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
import_protocol: ospf import_protocol: ospf
import_process_id: 123 import_process_id: 123
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo import route" - name: "Undo import route"
ce_bgp_af: ce_bgp_af:
state: absent state: absent
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
import_protocol: ospf import_protocol: ospf
import_process_id: 123 import_process_id: 123
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config network route" - name: "Config network route"
ce_bgp_af: ce_bgp_af:
state: present state: present
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
network_address: 1.1.1.1 network_address: 1.1.1.1
mask_len: 24 mask_len: 24
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo network route" - name: "Undo network route"
ce_bgp_af: ce_bgp_af:
state: absent state: absent
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
network_address: 1.1.1.1 network_address: 1.1.1.1
mask_len: 24 mask_len: 24
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -250,17 +250,17 @@ EXAMPLES = '''
- name: "Config bgp peer" - name: "Config bgp peer"
ce_bgp_neighbor: ce_bgp_neighbor:
state: present state: present
vrf_name: js vrf_name: js
peer_addr: 192.168.10.10 peer_addr: 192.168.10.10
remote_as: 500 remote_as: 500
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config bgp route id" - name: "Config bgp route id"
ce_bgp_neighbor: ce_bgp_neighbor:
state: absent state: absent
vrf_name: js vrf_name: js
peer_addr: 192.168.10.10 peer_addr: 192.168.10.10
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -406,20 +406,20 @@ EXAMPLES = '''
- name: "Config BGP peer Address_Family" - name: "Config BGP peer Address_Family"
ce_bgp_neighbor_af: ce_bgp_neighbor_af:
state: present state: present
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
remote_address: 192.168.10.10 remote_address: 192.168.10.10
nexthop_configure: local nexthop_configure: local
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo BGP peer Address_Family" - name: "Undo BGP peer Address_Family"
ce_bgp_neighbor_af: ce_bgp_neighbor_af:
state: absent state: absent
vrf_name: js vrf_name: js
af_type: ipv4uni af_type: ipv4uni
remote_address: 192.168.10.10 remote_address: 192.168.10.10
nexthop_configure: local nexthop_configure: local
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -52,7 +52,6 @@ options:
by the configured retries, the task fails. See examples. by the configured retries, the task fails. See examples.
required: false required: false
default: null default: null
aliases: ['waitfor']
match: match:
description: description:
- The I(match) argument is used in conjunction with the - The I(match) argument is used in conjunction with the
@ -201,7 +200,7 @@ def main():
# { command: <str>, output: <str>, prompt: <str>, response: <str> } # { command: <str>, output: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True), commands=dict(type='list', required=True),
wait_for=dict(type='list', aliases=['waitfor']), wait_for=dict(type='list'),
match=dict(default='all', choices=['any', 'all']), match=dict(default='all', choices=['any', 'all']),
retries=dict(default=10, type='int'), retries=dict(default=10, type='int'),

View file

@ -32,8 +32,8 @@ author:
- Zhijin Zhou (@CloudEngine-Ansible) - Zhijin Zhou (@CloudEngine-Ansible)
notes: notes:
- The relevant configurations will be deleted if DLDP is disabled using enable=disable. - The relevant configurations will be deleted if DLDP is disabled using enable=disable.
- When using auth_mode=none, it will restore the default DLDP authentication mode(By default, - When using auth_mode=none, it will restore the default DLDP authentication mode. By default,
DLDP packets are not authenticated.). DLDP packets are not authenticated.
- By default, the working mode of DLDP is enhance, so you are advised to use work_mode=enhance to restore defualt - By default, the working mode of DLDP is enhance, so you are advised to use work_mode=enhance to restore defualt
DLDP working mode. DLDP working mode.
- The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to - The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to

View file

@ -57,18 +57,18 @@ options:
description: description:
- Configures a route distinguisher (RD) for a BD EVPN instance. - Configures a route distinguisher (RD) for a BD EVPN instance.
The format of an RD can be as follows The format of an RD can be as follows
1) 2-byte AS number:4-byte user-defined number, for example, 1:3. An AS number is an integer ranging from - 1) 2-byte AS number:4-byte user-defined number, for example, 1:3. An AS number is an integer ranging from
0 to 65535, and a user-defined number is an integer ranging from 0 to 4294967295. The AS and user-defined 0 to 65535, and a user-defined number is an integer ranging from 0 to 4294967295. The AS and user-defined
numbers cannot be both 0s. This means that an RD cannot be 0:0. numbers cannot be both 0s. This means that an RD cannot be 0:0.
2) Integral 4-byte AS number:2-byte user-defined number, for example, 65537:3. An AS number is an integer - 2) Integral 4-byte AS number:2-byte user-defined number, for example, 65537:3. An AS number is an integer
ranging from 65536 to 4294967295, and a user-defined number is an integer ranging from 0 to 65535. ranging from 65536 to 4294967295, and a user-defined number is an integer ranging from 0 to 65535.
3) 4-byte AS number in dotted notation:2-byte user-defined number, for example, 0.0:3 or 0.1:0. A 4-byte - 3) 4-byte AS number in dotted notation:2-byte user-defined number, for example, 0.0:3 or 0.1:0. A 4-byte
AS number in dotted notation is in the format of x.y, where x and y are integers ranging from 0 to 65535. AS number in dotted notation is in the format of x.y, where x and y are integers ranging from 0 to 65535.
4) A user-defined number is an integer ranging from 0 to 65535. The AS and user-defined numbers cannot be - 4) A user-defined number is an integer ranging from 0 to 65535. The AS and user-defined numbers cannot be
both 0s. This means that an RD cannot be 0.0:0. both 0s. This means that an RD cannot be 0.0:0.
5) 32-bit IP address:2-byte user-defined number. For example, 192.168.122.15:1. An IP address ranges from - 5) 32-bit IP address:2-byte user-defined number. For example, 192.168.122.15:1. An IP address ranges from
0.0.0.0 to 255.255.255.255, and a user-defined number is an integer ranging from 0 to 65535. 0.0.0.0 to 255.255.255.255, and a user-defined number is an integer ranging from 0 to 65535.
6) 'auto' specifies the RD that is automatically generated. - 6) 'auto' specifies the RD that is automatically generated.
required: false required: false
default: null default: null
vpn_target_both: vpn_target_both:

View file

@ -72,12 +72,12 @@ EXAMPLES = """
- name: "Collect only the config facts" - name: "Collect only the config facts"
ce_facts: ce_facts:
gather_subset: config gather_subset: config
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Do not collect hardware facts" - name: "Do not collect hardware facts"
ce_facts: ce_facts:
gather_subset: "!hardware" gather_subset: "!hardware"
provider: "{{ cli }}" provider: "{{ cli }}"
""" """

View file

@ -90,32 +90,32 @@ EXAMPLES = '''
- name: "Config debug time stamp" - name: "Config debug time stamp"
ce_info_center_debug: ce_info_center_debug:
state: present state: present
debug_time_stamp: date_boot debug_time_stamp: date_boot
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo debug time stamp" - name: "Undo debug time stamp"
ce_info_center_debug: ce_info_center_debug:
state: absent state: absent
debug_time_stamp: date_boot debug_time_stamp: date_boot
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config debug module log level" - name: "Config debug module log level"
ce_info_center_debug: ce_info_center_debug:
state: present state: present
module_name: aaa module_name: aaa
channel_id: 1 channel_id: 1
debug_enable: true debug_enable: true
debug_level: error debug_level: error
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo debug module log level" - name: "Undo debug module log level"
ce_info_center_debug: ce_info_center_debug:
state: absent state: absent
module_name: aaa module_name: aaa
channel_id: 1 channel_id: 1
debug_enable: true debug_enable: true
debug_level: error debug_level: error
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -102,34 +102,34 @@ EXAMPLES = '''
- name: "Config trap buffer" - name: "Config trap buffer"
ce_info_center_trap: ce_info_center_trap:
state: present state: present
trap_buff_enable: true trap_buff_enable: true
trap_buff_size: 768 trap_buff_size: 768
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo trap buffer" - name: "Undo trap buffer"
ce_info_center_trap: ce_info_center_trap:
state: absent state: absent
trap_buff_enable: true trap_buff_enable: true
trap_buff_size: 768 trap_buff_size: 768
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config trap module log level" - name: "Config trap module log level"
ce_info_center_trap: ce_info_center_trap:
state: present state: present
module_name: aaa module_name: aaa
channel_id: 1 channel_id: 1
trap_enable: true trap_enable: true
trap_level: error trap_level: error
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo trap module log level" - name: "Undo trap module log level"
ce_info_center_trap: ce_info_center_trap:
state: absent state: absent
module_name: aaa module_name: aaa
channel_id: 1 channel_id: 1
trap_enable: true trap_enable: true
trap_level: error trap_level: error
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -90,29 +90,29 @@ EXAMPLES = '''
- name: Config ipv4 netstream record - name: Config ipv4 netstream record
ce_netstream_template: ce_netstream_template:
state: present state: present
type: ip type: ip
record_name: test record_name: test
provider: "{{ cli }}" provider: "{{ cli }}"
- name: Undo ipv4 netstream record - name: Undo ipv4 netstream record
ce_netstream_template: ce_netstream_template:
state: absent state: absent
type: ip type: ip
record_name: test record_name: test
provider: "{{ cli }}" provider: "{{ cli }}"
- name: Config ipv4 netstream record collect_counter - name: Config ipv4 netstream record collect_counter
ce_netstream_template: ce_netstream_template:
state: present state: present
type: ip type: ip
record_name: test record_name: test
collect_counter: bytes collect_counter: bytes
provider: "{{ cli }}" provider: "{{ cli }}"
- name: Undo ipv4 netstream record collect_counter - name: Undo ipv4 netstream record collect_counter
ce_netstream_template: ce_netstream_template:
state: absent state: absent
type: ip type: ip
record_name: test record_name: test
collect_counter: bytes collect_counter: bytes
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -94,8 +94,8 @@ options:
lsaointervalflag: lsaointervalflag:
description: description:
- Specifies whether cancel the interval of LSA originate or not. - Specifies whether cancel the interval of LSA originate or not.
If set the parameter but noe specifies value ,the default will be used. If set the parameter but noe specifies value, the default will be used.
true:cancel the interval of LSA originate,the interval is 0. true:cancel the interval of LSA originate, the interval is 0.
false:do not cancel the interval of LSA originate. false:do not cancel the interval of LSA originate.
required: false required: false
default: False default: False

View file

@ -33,7 +33,6 @@ options:
confirm: confirm:
description: description:
- Safeguard boolean. Set to true if you're sure you want to reboot. - Safeguard boolean. Set to true if you're sure you want to reboot.
required: true
type: bool type: bool
default: false default: false
save_config: save_config:

View file

@ -103,32 +103,32 @@ EXAMPLES = '''
- name: "Config SNMP community" - name: "Config SNMP community"
ce_snmp_community: ce_snmp_community:
state: present state: present
community_name: Wdz123456789 community_name: Wdz123456789
access_right: write access_right: write
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo SNMP community" - name: "Undo SNMP community"
ce_snmp_community: ce_snmp_community:
state: absent state: absent
community_name: Wdz123456789 community_name: Wdz123456789
access_right: write access_right: write
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP group" - name: "Config SNMP group"
ce_snmp_community: ce_snmp_community:
state: present state: present
group_name: wdz_group group_name: wdz_group
security_level: noAuthNoPriv security_level: noAuthNoPriv
acl_number: 2000 acl_number: 2000
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo SNMP group" - name: "Undo SNMP group"
ce_snmp_community: ce_snmp_community:
state: absent state: absent
group_name: wdz_group group_name: wdz_group
security_level: noAuthNoPriv security_level: noAuthNoPriv
acl_number: 2000 acl_number: 2000
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -61,14 +61,14 @@ EXAMPLES = '''
- name: "Config SNMP contact" - name: "Config SNMP contact"
ce_snmp_contact: ce_snmp_contact:
state: present state: present
contact: call Operator at 010-99999999 contact: call Operator at 010-99999999
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo SNMP contact" - name: "Undo SNMP contact"
ce_snmp_contact: ce_snmp_contact:
state: absent state: absent
contact: call Operator at 010-99999999 contact: call Operator at 010-99999999
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -61,14 +61,14 @@ EXAMPLES = '''
- name: "Config SNMP location" - name: "Config SNMP location"
ce_snmp_location: ce_snmp_location:
state: present state: present
location: nanjing China location: nanjing China
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Remove SNMP location" - name: "Remove SNMP location"
ce_snmp_location: ce_snmp_location:
state: absent state: absent
location: nanjing China location: nanjing China
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -120,19 +120,19 @@ EXAMPLES = '''
- name: "Config SNMP version" - name: "Config SNMP version"
ce_snmp_target_host: ce_snmp_target_host:
state: present state: present
version: v2cv3 version: v2cv3
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP target host" - name: "Config SNMP target host"
ce_snmp_target_host: ce_snmp_target_host:
state: present state: present
host_name: test1 host_name: test1
address: 1.1.1.1 address: 1.1.1.1
notify_type: trap notify_type: trap
vpn_name: js vpn_name: js
security_model: v2c security_model: v2c
security_name: wdz security_name: wdz
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -86,21 +86,21 @@ EXAMPLES = '''
- name: "Config SNMP trap all enable" - name: "Config SNMP trap all enable"
ce_snmp_traps: ce_snmp_traps:
state: present state: present
feature_name: all feature_name: all
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP trap interface" - name: "Config SNMP trap interface"
ce_snmp_traps: ce_snmp_traps:
state: present state: present
interface_type: 40GE interface_type: 40GE
interface_number: 2/0/1 interface_number: 2/0/1
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP trap port" - name: "Config SNMP trap port"
ce_snmp_traps: ce_snmp_traps:
state: present state: present
port_number: 2222 port_number: 2222
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -24,7 +24,7 @@ DOCUMENTATION = '''
--- ---
module: ce_snmp_user module: ce_snmp_user
version_added: "2.4" version_added: "2.4"
short_description: Manages SNMP user configuration. short_description: Manages SNMP user configuration on HUAWEI CloudEngine switches.
description: description:
- Manages SNMP user configurations on CloudEngine switches. - Manages SNMP user configurations on CloudEngine switches.
author: author:
@ -97,40 +97,40 @@ EXAMPLES = '''
- name: "Config SNMP usm user" - name: "Config SNMP usm user"
ce_snmp_user: ce_snmp_user:
state: present state: present
usm_user_name: wdz_snmp usm_user_name: wdz_snmp
remote_engine_id: 800007DB03389222111200 remote_engine_id: 800007DB03389222111200
acl_number: 2000 acl_number: 2000
user_group: wdz_group user_group: wdz_group
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo SNMP usm user" - name: "Undo SNMP usm user"
ce_snmp_user: ce_snmp_user:
state: absent state: absent
usm_user_name: wdz_snmp usm_user_name: wdz_snmp
remote_engine_id: 800007DB03389222111200 remote_engine_id: 800007DB03389222111200
acl_number: 2000 acl_number: 2000
user_group: wdz_group user_group: wdz_group
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP local user" - name: "Config SNMP local user"
ce_snmp_user: ce_snmp_user:
state: present state: present
aaa_local_user: wdz_user aaa_local_user: wdz_user
auth_protocol: md5 auth_protocol: md5
auth_key: huawei123 auth_key: huawei123
priv_protocol: des56 priv_protocol: des56
priv_key: huawei123 priv_key: huawei123
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Config SNMP local user" - name: "Config SNMP local user"
ce_snmp_user: ce_snmp_user:
state: absent state: absent
aaa_local_user: wdz_user aaa_local_user: wdz_user
auth_protocol: md5 auth_protocol: md5
auth_key: huawei123 auth_key: huawei123
priv_protocol: des56 priv_protocol: des56
priv_key: huawei123 priv_key: huawei123
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -157,12 +157,12 @@ existing:
description: k/v pairs of existing switchport description: k/v pairs of existing switchport
returned: always returned: always
type: dict type: dict
sample: {} sample: {}
end_state: end_state:
description: k/v pairs of switchport after module execution description: k/v pairs of switchport after module execution
returned: always returned: always
type: dict type: dict
sample: {"next_hop": "3.3.3.3", "pref": "100", sample: {"next_hop": "3.3.3.3", "pref": "100",
"prefix": "192.168.20.0", "mask": "24", "description": "testing", "prefix": "192.168.20.0", "mask": "24", "description": "testing",
"tag" : "null"} "tag" : "null"}
updates: updates:

View file

@ -140,26 +140,26 @@ EXAMPLES = '''
- name: "Config stp mode" - name: "Config stp mode"
ce_stp: ce_stp:
state: present state: present
stp_mode: stp stp_mode: stp
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Undo stp mode" - name: "Undo stp mode"
ce_stp: ce_stp:
state: absent state: absent
stp_mode: stp stp_mode: stp
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Enable bpdu protection" - name: "Enable bpdu protection"
ce_stp: ce_stp:
state: present state: present
bpdu_protection: enable bpdu_protection: enable
provider: "{{ cli }}" provider: "{{ cli }}"
- name: "Disable bpdu protection" - name: "Disable bpdu protection"
ce_stp: ce_stp:
state: present state: present
bpdu_protection: disable bpdu_protection: disable
provider: "{{ cli }}" provider: "{{ cli }}"
''' '''

View file

@ -63,15 +63,13 @@ options:
description: description:
- If C(mode=trunk), used as the VLAN range to ADD or REMOVE - If C(mode=trunk), used as the VLAN range to ADD or REMOVE
from the trunk, such as 2-10 or 2,5,10-15, etc. from the trunk, such as 2-10 or 2,5,10-15, etc.
aliases:
- trunk_add_vlans
required: false required: false
default: null default: null
state: state:
description: description:
- Manage the state of the resource. - Manage the state of the resource.
required: false required: false
default: present default: present
choices: ['present', 'absent', 'unconfigured'] choices: ['present', 'absent', 'unconfigured']
''' '''
@ -137,14 +135,14 @@ existing:
description: k/v pairs of existing switchport description: k/v pairs of existing switchport
returned: always returned: always
type: dict type: dict
sample: {"access_vlan": "10", "interface": "10GE1/0/22", sample: {"access_vlan": "10", "interface": "10GE1/0/22",
"mode": "access", "switchport": "enable"} "mode": "access", "switchport": "enable"}
end_state: end_state:
description: k/v pairs of switchport after module execution description: k/v pairs of switchport after module execution
returned: always returned: always
type: dict type: dict
sample: {"access_vlan": "20", "interface": "10GE1/0/22", sample: {"access_vlan": "20", "interface": "10GE1/0/22",
"mode": "access", "switchport": "enable"} "mode": "access", "switchport": "enable"}
updates: updates:
description: command string sent to the device description: command string sent to the device
returned: always returned: always