Docs4dev
Docs
ansible / 2.10 / collections / community / network / ce_netstream_template_module.html

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

Note

This plugin is part of the community.network collection (version 1.3.0).

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 Choices/Defaults Comments
collect_counter
string
    Choices:
  • bytes
  • packets
Configure the number of packets and bytes that are included in the flexible flow statistics sent to NSC.
collect_interface
string
    Choices:
  • input
  • output
Configure the input or output interface that are included in the flexible flow statistics sent to NSC.
description
string
Configure the description of netstream record. The value is a string of 1 to 80 case-insensitive characters.
match
string
    Choices:
  • destination-address
  • destination-port
  • tos
  • protocol
  • source-address
  • source-port
Configure flexible flow statistics template keywords.
record_name
string
Configure the name of netstream record. The value is a string of 1 to 32 case-insensitive characters.
state
string
    Choices:
  • present ←
  • absent
Specify desired state of the resource.
type
string / required
    Choices:
  • ip
  • vxlan
Configure the type of netstream record.

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 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', 'state': 'present', 'type': 'ip'}
updates
list / elements=string
always
command sent to the device

Sample:
['netstream record test ip']


Authors

  • wangdezhuang (@QijunPan)

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