Docs4dev
Docs
ansible / latest / collections / ngine_io / cloudstack / cs_traffic_type_module.html

ngine_io.cloudstack.cs_traffic_type – Manages traffic types on CloudStack Physical Networks

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).

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 ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_traffic_type.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • Add, remove, update Traffic Types associated with CloudStack Physical Networks.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments
api_http_method
string
    Choices:
  • get ←
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
hyperv_networklabel
string
The network name label of the physical device dedicated to this traffic on a HyperV host.
isolation_method
string
    Choices:
  • vlan
  • vxlan
Use if the physical network has multiple isolation types and traffic type is public.
kvm_networklabel
string
The network name label of the physical device dedicated to this traffic on a KVM host.
ovm3_networklabel
string
The network name of the physical device dedicated to this traffic on an OVM3 host.
physical_network
string / required
the name of the Physical Network
poll_async
boolean
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
state
string
    Choices:
  • present ←
  • absent
State of the traffic type
traffic_type
string / required
    Choices:
  • Management
  • Guest
  • Public
  • Storage
the trafficType to be added to the physical network.
vlan
string
The VLAN id to be used for Management traffic by VMware host.
vmware_networklabel
string
The network name label of the physical device dedicated to this traffic on a VMware host.
xen_networklabel
string
The network name label of the physical device dedicated to this traffic on a XenServer host.
zone
string / required
Name of the zone with the physical network.

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: add a traffic type
  ngine_io.cloudstack.cs_traffic_type:
    physical_network: public-network
    traffic_type: Guest
    zone: test-zone

- name: update traffic type
  ngine_io.cloudstack.cs_traffic_type:
    physical_network: public-network
    traffic_type: Guest
    kvm_networklabel: cloudbr0
    zone: test-zone

- name: remove traffic type
  ngine_io.cloudstack.cs_traffic_type:
    physical_network: public-network
    traffic_type: Public
    state: absent
    zone: test-zone

Return Values

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

Key Returned Description
hyperv_networklabel
string
success
The network name label of the physical device dedicated to this traffic on a HyperV host

Sample:
HyperV Internal Switch
id
string
success
ID of the network provider

Sample:
659c1840-9374-440d-a412-55ca360c9d3c
kvm_networklabel
string
success
The network name label of the physical device dedicated to this traffic on a KVM host

Sample:
cloudbr0
ovm3_networklabel
string
success
The network name of the physical device dedicated to this traffic on an OVM3 host

Sample:
cloudbr0
physical_network
string
success
the physical network this belongs to

Sample:
28ed70b7-9a1f-41bf-94c3-53a9f22da8b6
traffic_type
string
success
the trafficType that was added to the physical network

Sample:
Public
vmware_networklabel
string
success
The network name label of the physical device dedicated to this traffic on a VMware host

Sample:
Management Network
xen_networklabel
string
success
The network name label of the physical device dedicated to this traffic on a XenServer host

Sample:
xenbr0
zone
string
success
Name of zone the physical network is in.

Sample:
ch-gva-2


Authors

  • Patryk Cichy (@PatTheSilent)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_traffic_type_module.html