You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_acl - Manages base ACL configuration on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages base ACL configurations on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
acl_description	no			ACL description. The value is a string of 1 to 127 characters.
acl_name	yes			ACL number or name. For a numbered rule group, the value ranging from 2000 to 2999 indicates a basic ACL. For a named rule group, the value is a string of 1 to 32 case-sensitive characters starting with a letter, spaces not supported.
acl_num	no			ACL number. The value is an integer ranging from 2000 to 2999.
acl_step	no			ACL step. The value is an integer ranging from 1 to 20. The default value is 5.
frag_type	no		fragment clear_fragment	Type of packet fragmentation.
log_flag	no		true false	Flag of logging matched data packets.
rule_action	no		permit deny	Matching mode of basic ACL rules.
rule_description	no			Description about an ACL rule. The value is a string of 1 to 127 characters.
rule_id	no			ID of a basic ACL rule in configuration mode. The value is an integer ranging from 0 to 4294967294.
rule_name	no			Name of a basic ACL rule. The value is a string of 1 to 32 characters. The value is case-insensitive, and cannot contain spaces or begin with an underscore (_).
source_ip	no			Source IP address. The value is a string of 0 to 255 characters.The default value is 0.0.0.0. The value is in dotted decimal notation.
src_mask	no			Mask of a source IP address. The value is an integer ranging from 1 to 32.
state	no	present	present absent delete_acl	Specify desired state of the resource.
time_range	no			Name of a time range in which an ACL rule takes effect. The value is a string of 1 to 32 characters. The value is case-insensitive, and cannot contain spaces. The name must start with an uppercase or lowercase letter. In addition, the word "all" cannot be specified as a time range name.
vrf_name	no			VPN instance name. The value is a string of 1 to 31 characters.The default value is _public_.

Examples ¶

- name: CloudEngine acl test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config ACL"
    ce_acl:
      state: present
      acl_name: 2200
      provider: "{{ cli }}"

  - name: "Undo ACL"
    ce_acl:
      state: delete_acl
      acl_name: 2200
      provider: "{{ cli }}"

  - name: "Config ACL base rule"
    ce_acl:
      state: present
      acl_name: 2200
      rule_name: test_rule
      rule_id: 111
      rule_action: permit
      source_ip: 10.10.10.10
      src_mask: 24
      frag_type: fragment
      time_range: wdz_acl_time
      provider: "{{ cli }}"

  - name: "undo ACL base rule"
    ce_acl:
      state: absent
      acl_name: 2200
      rule_name: test_rule
      rule_id: 111
      rule_action: permit
      source_ip: 10.10.10.10
      src_mask: 24
      frag_type: fragment
      time_range: wdz_acl_time
      provider: "{{ cli }}"

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
changed	check to see if a change was made on the device	always	boolean	True
end_state	k/v pairs of aaa params after module execution	always	dict	{}
existing	k/v pairs of existing aaa server	always	dict	{'aclNumOrName': 'test', 'aclType': 'Basic'}
proposed	k/v pairs of parameters passed into module	always	dict	{'state': 'delete_acl', 'acl_name': 'test'}
updates	command sent to the device	always	list	['undo acl name test']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.