community.network.ce_netstream_template module – Manages NetStream template configuration on HUAWEI CloudEngine switches.

Note

This module is part of the community.network collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_netstream_template.

Synopsis

  • Manages NetStream template configuration on HUAWEI CloudEngine switches.

Parameters

Parameter

Comments

collect_counter

string

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

Choices:

  • "bytes"

  • "packets"

collect_interface

string

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

Choices:

  • "input"

  • "output"

description

string

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

match

string

Configure flexible flow statistics template keywords.

Choices:

  • "destination-address"

  • "destination-port"

  • "tos"

  • "protocol"

  • "source-address"

  • "source-port"

record_name

string

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

state

string

Specify desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

type

string / required

Configure the type of netstream record.

Choices:

  • "ip"

  • "vxlan"

Notes

Note

  • Recommended connection is network_cli.

  • This module also works with local connections for legacy playbooks.

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

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of aaa params after module execution

Returned: always

Sample: {"record_name": "test", "type": "ip"}

existing

dictionary

k/v pairs of existing aaa server

Returned: always

Sample: {}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"record_name": "test", "state": "present", "type": "ip"}

updates

list / elements=string

command sent to the device

Returned: always

Sample: ["netstream record test ip"]

Authors

  • wangdezhuang (@QijunPan)