Documentation

ce_netstream_global - Manages global parameters of NetStream on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages global parameters of NetStream on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
index_switch
    Choices:
  • 16 ←
  • 32
Specifies the netstream index-switch.
interface
required
Netstream global interface.
sampler_direction
    Choices:
  • inbound
  • outbound
Specifies the netstream sampler direction.
sampler_interval
Specifies the netstream sampler interval, length is 1 - 65535.
state
    Choices:
  • present ←
  • absent
Specify desired state of the resource.
statistics_direction
    Choices:
  • inbound
  • outbound
Specifies the netstream statistic direction.
statistics_record
Specifies the flexible netstream statistic record, length is 1 - 32.
type
    Choices:
  • ip ←
  • vxlan
Specifies the type of netstream global.

Examples

- name: netstream global 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: Configure a netstream sampler at interface 10ge1/0/2, direction is outbound,interval is 30.
    ce_netstream_global:
      interface: 10ge1/0/2
      type: ip
      sampler_interval: 30
      sampler_direction: outbound
      state: present
      provider: "{{ cli }}"
  - name: Configure a netstream flexible statistic at interface 10ge1/0/2, record is test1, type is ip.
    ce_netstream_global:
      type: ip
      interface: 10ge1/0/2
      statistics_record: test1
      provider: "{{ cli }}"
  - name: Set the vxlan index-switch to 32.
    ce_netstream_global:
      type: vxlan
      interface: all
      index_switch: 32
      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
dict
verbose mode
k/v pairs of configuration after module execution

Sample:
{'flexible_statistic': [{'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'ip'}, {'interface': '10ge1/0/2', 'statistics_record': ['test'], 'type': 'vxlan'}], 'sampler': [{'interface': 'all', 'sampler_interval': 'null', 'sampler_direction': 'null'}], 'index-switch': [{'type': 'ip', 'index-switch': '16'}, {'type': 'vxlan', 'index-switch': '16'}], 'statistic': [{'interface': '10ge1/0/2', 'statistics_direction': [], 'type': 'null'}]}
existing
dict
verbose mode
k/v pairs of existing configuration

Sample:
{'sampler': [{'interface': 'all', 'sampler_interval': 'null', 'sampler_direction': 'null'}], 'flexible_statistic': [{'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'ip'}, {'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'vxlan'}], 'vxlan_record': ['test'], 'statistic': [{'interface': '10ge1/0/2', 'statistics_direction': [], 'type': 'null'}], 'ip_record': ['test', 'test1'], 'index-switch': [{'type': 'ip', 'index-switch': '16'}, {'type': 'vxlan', 'index-switch': '16'}]}
proposed
dict
verbose mode
k/v pairs of parameters passed into module

Sample:
{'interface': '10ge1/0/2', 'state': 'present', 'index_switch': '16', 'type': 'vxlan', 'statistics_record': 'test'}
updates
list
always
commands sent to the device

Sample:
['interface 10ge1/0/2', 'netstream record test vxlan inner-ip']


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • YangYang (@CloudEngine-Ansible)

Hint

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