Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the network is related to.
|
acl
(added in 2.5) |
|
The name of the access control list for the VPC network tier.
|
acl_type
|
Choices:
account ←
- domain
|
Access control type for the VPC network tier.
Only considered on create.
|
api_http_method
|
|
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
|
api_key
|
|
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
api_region
|
Default:
cloudstack
|
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
|
api_secret
|
|
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
api_timeout
|
|
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
|
api_url
|
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
cidr_ipv6
|
|
CIDR of IPv6 network, must be at least /64.
Only considered on create.
|
clean_up
bool |
|
Cleanup old network elements.
Only considered on state=restarted .
|
display_text
|
|
Display text of the network.
If not specified, name will be used as display_text .
|
domain
|
|
Domain the network is related to.
|
end_ip
|
|
The ending IPv4 address of the network belongs to.
If not specified, value of start_ip is used.
Only considered on create.
|
end_ipv6
|
|
The ending IPv6 address of the network belongs to.
If not specified, value of start_ipv6 is used.
Only considered on create.
|
gateway
|
|
The gateway of the network.
Required for shared networks and isolated networks when it belongs to a VPC.
Only considered on create.
|
gateway_ipv6
|
|
The gateway of the IPv6 network.
Required for shared networks.
Only considered on create.
|
isolated_pvlan
|
|
The isolated private VLAN for this network.
|
name
required |
|
Name (case sensitive) of the network.
|
netmask
|
|
The netmask of the network.
Required for shared networks and isolated networks when it belongs to a VPC.
Only considered on create.
|
network_domain
|
|
The network domain.
|
network_offering
|
|
Name of the offering for the network.
Required if state=present .
|
poll_async
bool |
|
Poll async jobs until job has finished.
|
project
|
|
Name of the project the network to be deployed in.
|
start_ip
|
|
The beginning IPv4 address of the network belongs to.
Only considered on create.
|
start_ipv6
|
|
The beginning IPv6 address of the network belongs to.
Only considered on create.
|
state
|
Choices:
present ←
- absent
- restarted
|
State of the network.
|
subdomain_access
bool
(added in 2.5) |
|
Defines whether to allow subdomains to use networks dedicated to their parent domain(s).
Should be used with acl_type=domain .
Only considered on create.
|
vlan
|
|
The ID or VID of the network.
|
vpc
|
|
Name of the VPC of the network.
|
zone
|
|
Name of the zone in which the network should be deployed.
If not set, default zone is used.
|