Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the vm is related to.
|
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.
|
domain
|
|
Domain the vm is related to.
|
ip_address
required |
|
Public IP address the rule is assigned to.
|
network
(added in 2.3) |
|
Name of the network.
|
open_firewall
|
Default:
no
|
Whether the firewall rule for public port should be created, while creating the new rule.
Use cs_firewall for managing firewall rules.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
private_end_port
|
|
End private port for this rule.
If not specified equal private_port .
|
private_port
required |
|
Start private port for this rule.
|
project
|
|
Name of the project the vm is located in.
|
protocol
|
|
Protocol of the port forwarding rule.
|
public_end_port
|
|
End public port for this rule.
If not specified equal public_port .
|
public_port
required |
|
Start public port for this rule.
|
state
|
Choices:
present ←
- absent
|
State of the port forwarding rule.
|
tags
(added in 2.4) |
|
List of tags. Tags are a list of dictionaries having keys key and value .
To delete all tags, set a empty list e.g. tags: [] .
aliases: tag
|
vm
|
|
Name of virtual machine which we make the port forwarding rule for.
Required if state=present .
|
vm_guest_ip
|
Default:
no
|
VM guest NIC secondary IP address for the port forwarding rule.
|
vpc
(added in 2.3) |
|
Name of the VPC.
|
zone
|
|
Name of the zone in which the virtual machine is in.
If not set, default zone is used.
|