Parameter |
Choices/Defaults |
Comments |
api_timeout
|
|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
|
auth
|
|
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
|
auth_type
|
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
|
auto_ip
bool |
|
Ensure instance has public ip however the cloud wants to do that
aliases: auto_floating_ip, public_ip
|
availability_zone
|
|
Availability zone in which to create the server.
|
boot_from_volume
bool |
|
Should the instance boot from a persistent volume created based on the image given. Mututally exclusive with boot_volume.
|
boot_volume
|
|
Volume name or id to use as the volume to boot from. Implies boot_from_volume. Mutually exclusive with image and boot_from_volume.
aliases: root_volume
|
cacert
|
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
|
cert
|
|
A path to a client certificate to use as part of the SSL transaction.
|
cloud
|
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
|
config_drive
bool |
|
Whether to boot the server with config drive enabled
|
delete_fip
bool
(added in 2.2) |
|
When state is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance.
|
flavor
|
Default:
1
|
The name or id of the flavor in which the new instance has to be created. Mutually exclusive with flavor_ram
|
flavor_include
|
|
Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor_include is a positive match filter - it must exist in the flavor name.
|
flavor_ram
|
Default:
1
|
The minimum amount of ram in MB that the flavor in which the new instance has to be created must have. Mutually exclusive with flavor.
|
floating_ip_pools
|
|
Name of floating IP pool from which to choose a floating IP
|
floating_ips
|
|
list of valid floating IPs that pre-exist to assign to this node
|
image
required |
|
The name or id of the base image to boot.
|
image_exclude
|
|
Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image_exclude is a negative match filter - it is text that may not exist in the image name. Defaults to "(deprecated)"
|
interface
(added in 2.3) |
Choices:
public ←
- internal
- admin
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
key
|
|
A path to a client key to use as part of the SSL transaction.
|
key_name
|
|
The key pair name to be used when creating a instance
|
meta
|
|
A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs. Eg: meta: "key1=value1,key2=value2"
|
name
required |
|
Name that has to be given to the instance
|
network
|
|
Name or ID of a network to attach this instance to. A simpler version of the nics parameter, only one of network or nics should be supplied.
|
nics
|
|
A list of networks to which the instance's interface should be attached. Networks may be referenced by net-id/net-name/port-id or port-name.
Also this accepts a string containing a list of (net/port)-(id/name) Eg: nics: "net-id=uuid-1,port-name=myport" Only one of network or nics should be supplied.
|
region_name
|
|
Name of the region.
|
reuse_ips
bool
(added in 2.2) |
|
When auto_ip is true and this option is true, the auto_ip code will attempt to re-use unassigned floating ips in the project before creating a new one. It is important to note that it is impossible to safely do this concurrently, so if your use case involves concurrent server creation, it is highly recommended to set this to false and to delete the floating ip associated with a server when the server is deleted using delete_fip.
|
scheduler_hints
(added in 2.1) |
|
Arbitrary key/value pairs to the scheduler for custom use
|
security_groups
|
|
Names of the security groups to which the instance should be added. This may be a YAML list or a comma separated string.
|
state
|
Choices:
present ←
- absent
|
Should the resource be present or absent.
|
terminate_volume
bool |
|
If yes , delete volume when deleting instance (if booted from volume)
|
timeout
|
Default:
180
|
The amount of time the module should wait for the instance to get into active state.
|
userdata
|
|
Opaque blob of data which is made available to the instance
|
verify
bool |
|
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: validate_certs
|
volume_size
|
|
The size of the volume to create in GB if booting from volume based on an image.
|
volumes
|
Default:
[]
|
A list of preexisting volumes names or ids to attach to the instance
|
wait
bool |
|
If the module should wait for the instance to be created.
|