ce_netstream_template – Manages NetStream template configuration on HUAWEI CloudEngine switches.

From Get docs
Ansible/docs/2.7/modules/ce netstream template module


ce_netstream_template – Manages NetStream template configuration on HUAWEI CloudEngine switches.

New in version 2.4.


Synopsis

  • Manages NetStream template configuration on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments

collect_counter

-

  • bytes
  • packets

Configure the number of packets and bytes that are included in the flexible flow statistics sent to NSC.

collect_interface

-

  • input
  • output

Configure the input or output interface that are included in the flexible flow statistics sent to NSC.

description

-

Configure the description of netstream record. The value is a string of 1 to 80 case-insensitive characters.

match

-

  • destination-address
  • destination-port
  • tos
  • protocol
  • source-address
  • source-port

Configure flexible flow statistics template keywords.

record_name

-

Configure the name of netstream record. The value is a string of 1 to 32 case-insensitive characters.

state

-

  • present

  • absent

Specify desired state of the resource.

type

- / required

  • ip
  • vxlan

Configure the type of netstream record.



Examples

- name: netstream template module 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 ipv4 netstream record
    ce_netstream_template:
      state: present
      type: ip
      record_name: test
      provider: "{{ cli }}"
  - name: Undo ipv4 netstream record
    ce_netstream_template:
      state: absent
      type: ip
      record_name: test
      provider: "{{ cli }}"
  - name: Config ipv4 netstream record collect_counter
    ce_netstream_template:
      state: present
      type: ip
      record_name: test
      collect_counter: bytes
      provider: "{{ cli }}"
  - name: Undo ipv4 netstream record collect_counter
    ce_netstream_template:
      state: absent
      type: ip
      record_name: test
      collect_counter: bytes
      provider: "{{ cli }}"

Return Values

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

Key Returned Description

changed

boolean

always

check to see if a change was made on the device


Sample:

True

end_state

dictionary

always

k/v pairs of aaa params after module execution


Sample:

{'record_name': 'test', 'type': 'ip'}

existing

dictionary

always

k/v pairs of existing aaa server


proposed

dictionary

always

k/v pairs of parameters passed into module


Sample:

{'record_name': 'test', 'type': 'ip', 'state': 'present'}

updates

list

always

command sent to the device


Sample:

['netstream record test ip']




Status

Authors

  • wangdezhuang (@CloudEngine-Ansible)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ce_netstream_template_module.html