Documentation

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.

Options

parameter required default choices comments
collect_counter
 no
  • bytes
  • packets
Configure the number of packets and bytes that are included in the flexible flow statistics sent to NSC.
collect_interface
 no
  • input
  • output
Configure the input or output interface that are included in the flexible flow statistics sent to NSC.
description
 no
Configure the description of netstream record. The value is a string of 1 to 80 case-insensitive characters.
match
 no
  • destination-address
  • destination-port
  • tos
  • protocol
  • source-address
  • source-port
Configure flexible flow statistics template keywords.
record_name
 no
Configure the name of netstream record. The value is a string of 1 to 32 case-insensitive characters.
state
 no present
  • present
  • absent
Specify desired state of the resource.
type
 yes
  • 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 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 {'record_name': 'test', 'type': 'ip'}
existing
k/v pairs of existing aaa server
 always dict {}
proposed
k/v pairs of parameters passed into module
 always dict {'record_name': 'test', 'state': 'present', 'type': 'ip'}
updates
command sent to the device
 always list ['netstream record test ip']


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.