cs_network - Manages networks on Apache CloudStack based clouds.
New in version 2.0.
Synopsis
- Create, update, restart and delete networks.
Requirements (on host that executes module)
- python >= 2.6
- cs >= 0.6.10
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
account | no | Account the network is related to. | ||
acl_type | no | account |
| Access control type. Only considered on create. |
api_http_method | no | get |
| HTTP method used. |
api_key | no | API key of the CloudStack API. | ||
api_region | no | cloudstack | Name of the ini section in the cloustack.ini file. | |
api_secret | no | Secret key of the CloudStack API. | ||
api_timeout | no | 10 | HTTP timeout. | |
api_url | no | URL of the CloudStack API e.g. https://cloud.example.com/client/api. | ||
cidr_ipv6 | no | CIDR of IPv6 network, must be at least /64. Only considered on create. | ||
clean_up | no | Cleanup old network elements. Only considered on state=restarted . | ||
display_text | no | Display text of the network. If not specified, name will be used as display_text . | ||
domain | no | Domain the network is related to. | ||
end_ip | no | The ending IPv4 address of the network belongs to. If not specified, value of start_ip is used.Only considered on create. | ||
end_ipv6 | no | The ending IPv6 address of the network belongs to. If not specified, value of start_ipv6 is used.Only considered on create. | ||
gateway | no | The gateway of the network. Required for shared networks and isolated networks when it belongs to a VPC. Only considered on create. | ||
gateway_ipv6 | no | The gateway of the IPv6 network. Required for shared networks. Only considered on create. | ||
isolated_pvlan | no | The isolated private VLAN for this network. | ||
name | yes | Name (case sensitive) of the network. | ||
netmask | no | The netmask of the network. Required for shared networks and isolated networks when it belongs to a VPC. Only considered on create. | ||
network_domain | no | The network domain. | ||
network_offering | no | Name of the offering for the network. Required if state=present . | ||
poll_async | no | True | Poll async jobs until job has finished. | |
project | no | Name of the project the network to be deployed in. | ||
start_ip | no | The beginning IPv4 address of the network belongs to. Only considered on create. | ||
start_ipv6 | no | The beginning IPv6 address of the network belongs to. Only considered on create. | ||
state | no | present |
| State of the network. |
vlan | no | The ID or VID of the network. | ||
vpc | no | Name of the VPC of the network. | ||
zone | no | Name of the zone in which the network should be deployed. If not set, default zone is used. |
Examples
# create a network - local_action: module: cs_network name: my network zone: gva-01 network_offering: DefaultIsolatedNetworkOfferingWithSourceNatService network_domain: example.com # update a network - local_action: module: cs_network name: my network display_text: network of domain example.local network_domain: example.local # restart a network with clean up - local_action: module: cs_network name: my network clean_up: yes state: restared # remove a network - local_action: module: cs_network name: my network state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
account | Account the network is related to. | success | string | example account |
acl_type | Access type of the network (Domain, Account). | success | string | Account |
broadcast_domain_type | Broadcast domain type of the network. | success | string | Vlan |
cidr | IPv4 network CIDR. | success | string | 10.101.64.0/24 |
cidr_ipv6 | IPv6 network CIDR. | success | string | 2001:db8::/64 |
display_text | Display text of the network. | success | string | web project |
dns1 | IP address of the 1st nameserver. | success | string | 1.2.3.4 |
dns2 | IP address of the 2nd nameserver. | success | string | 1.2.3.4 |
domain | Domain the network is related to. | success | string | ROOT |
gateway | IPv4 gateway. | success | string | 10.101.64.1 |
gateway_ipv6 | IPv6 gateway. | success | string | 2001:db8::1 |
id | UUID of the network. | success | string | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
is_persistent | Whether the network is persistent or not. | success | boolean | False |
name | Name of the network. | success | string | web project |
netmask | IPv4 netmask. | success | string | 255.255.255.0 |
network_domain | The network domain | success | string | example.local |
network_offering | The network offering name. | success | string | DefaultIsolatedNetworkOfferingWithSourceNatService |
project | Name of project. | success | string | Production |
state | State of the network (Allocated, Implemented, Setup). | success | string | Allocated |
tags | List of resource tags associated with the network. | success | dict | [ { "key": "foo", "value": "bar" } ] |
traffic_type | Traffic type of the network. | success | string | Guest |
type | Type of the network. | success | string | Isolated |
zone | Name of zone. | success | string | ch-gva-2 |
Notes
Note
- Ansible uses the
cs
library’s configuration method if credentials are not provided by the argumentsapi_url
,api_key
,api_secret
. Configuration is read from several locations, in the following order. - TheCLOUDSTACK_ENDPOINT
,CLOUDSTACK_KEY
,CLOUDSTACK_SECRET
andCLOUDSTACK_METHOD
.CLOUDSTACK_TIMEOUT
environment variables. - ACLOUDSTACK_CONFIG
environment variable pointing to an.ini
file, - Acloudstack.ini
file in the current working directory. - A.cloudstack.ini
file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini
. Use the argumentapi_region
to select the section name, default section iscloudstack
. See https://github.com/exoscale/cs for more information. - A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
- This module supports check mode.
Status
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_network_module.html