# Server ## server Create, update, destroy, update, start, stop, and reboot a Ionos virtual machine. When the virtual machine is created it can optionally wait for it to be 'running' before returning. The CUBE functionality of the server module is DEPRECATED. Please use the new cube\_server module for operations with CUBE servers. ### Example Syntax ```yaml name: Provision two servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' name: 'AnsibleAutoTestCompute %02d' cores: 1 ram: 1024 availability_zone: ZONE_1 lan: 'AnsibleAutoTestCompute' volume_availability_zone: ZONE_3 volume_size: 20 cpu_family: INTEL_SKYLAKE disk_type: SSD Standard image: 'ubuntu:latest' image_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' location: 'gb/lhr' user_data: '' count: 2 remove_boot_volume: true wait: true wait_timeout: '500' state: present register: server_create_result name: Update servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute 01' - 'AnsibleAutoTestCompute 02' cores: 2 cpu_family: INTEL_SKYLAKE ram: 2048 wait_timeout: '500' state: update name: Remove servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' remove_boot_volume: true wait_timeout: '500' state: absent name: Start servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' wait_timeout: '500' state: running name: Stop servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' wait_timeout: '500' state: stopped ``` ### Returned object ```json { "changed": false, "failed": false, "machines": [ { "entities": { "cdroms": { "links": null, "href": "https://api.ionos.com/cloudapi/v6/datacenters/f6e15460-e5eb-451a-9da7-08c9da65a179/servers/78ce195d-147b-48d8-a20e-57104b99badd/cdroms", "id": "78ce195d-147b-48d8-a20e-57104b99badd/cdroms", "items": null, "limit": null, "offset": null, "type": "collection" }, "nics": { "links": null, "href": "https://api.ionos.com/cloudapi/v6/datacenters/f6e15460-e5eb-451a-9da7-08c9da65a179/servers/78ce195d-147b-48d8-a20e-57104b99badd/nics", "id": "78ce195d-147b-48d8-a20e-57104b99badd/nics", "items": null, "limit": null, "offset": null, "type": "collection" }, "volumes": { "links": null, "href": "https://api.ionos.com/cloudapi/v6/datacenters/f6e15460-e5eb-451a-9da7-08c9da65a179/servers/78ce195d-147b-48d8-a20e-57104b99badd/volumes", "id": "78ce195d-147b-48d8-a20e-57104b99badd/volumes", "items": null, "limit": null, "offset": null, "type": "collection" } }, "href": "https://api.ionos.com/cloudapi/v6/datacenters/f6e15460-e5eb-451a-9da7-08c9da65a179/servers/78ce195d-147b-48d8-a20e-57104b99badd", "id": "78ce195d-147b-48d8-a20e-57104b99badd", "metadata": { "created_by": "", "created_by_user_id": "", "created_date": "2023-05-29T09:17:01+00:00", "etag": "f9b2094caee723ec45475a17c223ddd2", "last_modified_by": "", "last_modified_by_user_id": "", "last_modified_date": "2023-05-29T09:17:01+00:00", "state": "AVAILABLE" }, "properties": { "availability_zone": "AUTO", "boot_cdrom": null, "boot_volume": { "href": "https://api.ionos.com/cloudapi/v6/datacenters/f6e15460-e5eb-451a-9da7-08c9da65a179/volumes/4e9d988c-d4d8-4de1-a325-7f1a7b0ea77f", "id": "4e9d988c-d4d8-4de1-a325-7f1a7b0ea77f", "type": "volume" }, "cores": 1, "cpu_family": "INTEL_SKYLAKE", "name": "AnsibleAutoTestCompute", "ram": 2048, "template_uuid": null, "type": "ENTERPRISE", "vm_state": "RUNNING" }, "type": "server" } ], "action": "create" } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/compute-engine). ## state: **running** ```yaml name: Start servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' wait_timeout: '500' state: running ``` #### Available parameters for state **running**:
NameRequiredDescription
datacenter
str		TrueThe datacenter to provision this virtual machine.
instance_ids
list		Falselist of instance ids. Should only contain one ID if renaming in update state
Default:
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['running', 'stopped', 'absent', 'present', 'update']
## state: **stopped** ```yaml name: Stop servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' wait_timeout: '500' state: stopped ``` #### Available parameters for state **stopped**:
NameRequiredDescription
datacenter
str		TrueThe datacenter to provision this virtual machine.
instance_ids
list		Falselist of instance ids. Should only contain one ID if renaming in update state
Default:
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['running', 'stopped', 'absent', 'present', 'update']
## state: **absent** ```yaml name: Remove servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute' - 'AnsibleAutoTestCompute 02' remove_boot_volume: true wait_timeout: '500' state: absent ``` #### Available parameters for state **absent**:
NameRequiredDescription
name
str		FalseThe name of the resource.
datacenter
str		TrueThe datacenter to provision this virtual machine.
instance_ids
list		Falselist of instance ids. Should only contain one ID if renaming in update state
Default:
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['running', 'stopped', 'absent', 'present', 'update']
## state: **present** ```yaml name: Provision two servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' name: 'AnsibleAutoTestCompute %02d' cores: 1 ram: 1024 availability_zone: ZONE_1 lan: 'AnsibleAutoTestCompute' volume_availability_zone: ZONE_3 volume_size: 20 cpu_family: INTEL_SKYLAKE disk_type: SSD Standard image: 'ubuntu:latest' image_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' location: 'gb/lhr' user_data: '' count: 2 remove_boot_volume: true wait: true wait_timeout: '500' state: present register: server_create_result ``` #### Available parameters for state **present**:
NameRequiredDescription
name
str		TrueThe name of the resource.
assign_public_ip
bool		FalseThis will assign the machine to the public LAN. If no LAN exists with public Internet access it is created.
Default: False
Options: [True, False]
image
str		TrueThe image alias or ID for creating the virtual machine.
image_password
str		FalsePassword set for the administrative user.
ssh_keys
list		FalsePublic SSH keys allowing access to the virtual machine.
Default:
user_data
str		FalseThe cloud-init configuration for the volume as base64 encoded string.
volume_availability_zone
str		FalseThe storage availability zone assigned to the volume.
Options: ['AUTO', 'ZONE_1', 'ZONE_2', 'ZONE_3']
datacenter
str		TrueThe datacenter to provision this virtual machine.
cores
int		FalseThe total number of cores for the server. It can not be supplied for the VMs that have to be created based on templates.
Default: 2
ram
int		FalseThe memory size for the server in MB, such as 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set ramHotPlug to TRUE then you must use a minimum of 1024 MB. If you set the RAM size more than 240GB, then ramHotPlug will be set to FALSE and can not be set to TRUE unless RAM size not set to less than 240GB. It can not be supplied for the VMs that have to be created based on templates.
Default: 2048
cpu_family
str		FalseCPU architecture on which server gets provisioned; not all CPU architectures are available in all datacenter regions; available CPU architectures can be retrieved from the datacenter resource; must not be provided for CUBE and VCPU servers. If the field is omitted from the request or the value is empty or null, an available CPU architecture will be automatically selected.
Options: ['INTEL_XEON', 'INTEL_SKYLAKE', 'INTEL_ICELAKE', 'AMD_EPYC', 'INTEL_SIERRAFOREST']
nic_multi_queue
bool		FalseActivate or deactivate the Multi Queue feature on all NICs of this server. This feature is beneficial to enable when the NICs are experiencing performance issues (e.g. low throughput). Toggling this feature will also initiate a restart of the server. If the specified value is `true`, the feature will be activated; if it is not specified or set to `false`, the feature will be deactivated. It is not allowed for servers of type Cube.
availability_zone
str		FalseThe availability zone in which the server should be provisioned. For CUBE and GPU servers, the only value accepted is 'AUTO'.
Default: AUTO
Options: ['AUTO', 'ZONE_1', 'ZONE_2']
volume_size
int		FalseThe size in GB of the boot volume.
Default: 10
bus
str		FalseThe bus type for the volume.
Default: VIRTIO
Options: ['IDE', 'VIRTIO']
count
int		FalseThe number of virtual machines to create.
Default: 1
location
str		FalseThe datacenter location. Use only if you want to create the Datacenter or else this value is ignored.
Default: us/las
Options: ['us/las', 'us/ewr', 'de/fra', 'de/fkb', 'de/txl', 'gb/lhr', 'es/vit', 'fr/par', 'us/mci']
lan
str		FalseThe ID or name of the LAN you wish to add the servers to (can be a string or a number).
nat
bool		FalseBoolean value indicating if the private IP address has outbound access to the public Internet.
Default: False
Options: [True, False]
remove_boot_volume
bool		FalseRemove the bootVolume of the virtual machine you're destroying.
Default: True
Options: [True, False]
disk_type
str		FalseThe disk type for the volume.
Default: HDD
Options: ['HDD', 'SSD', 'SSD Standard', 'SSD Premium', 'DAS']
nic_ips
list		FalseThe list of IPS for the NIC.
boot_volume
str		FalseThe volume used for boot.
boot_cdrom
str		FalseThe CDROM used for boot.
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['running', 'stopped', 'absent', 'present', 'update']
## state: **update** ```yaml name: Update servers ionoscloudsdk.ionoscloud.server: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute 01' - 'AnsibleAutoTestCompute 02' cores: 2 cpu_family: INTEL_SKYLAKE ram: 2048 wait_timeout: '500' state: update ``` #### Available parameters for state **update**:
NameRequiredDescription
name
str		FalseThe name of the resource.
datacenter
str		TrueThe datacenter to provision this virtual machine.
cores
int		FalseThe total number of cores for the server. It can not be supplied for the VMs that have to be created based on templates.
Default: 2
ram
int		FalseThe memory size for the server in MB, such as 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set ramHotPlug to TRUE then you must use a minimum of 1024 MB. If you set the RAM size more than 240GB, then ramHotPlug will be set to FALSE and can not be set to TRUE unless RAM size not set to less than 240GB. It can not be supplied for the VMs that have to be created based on templates.
Default: 2048
instance_ids
list		Falselist of instance ids. Should only contain one ID if renaming in update state
Default:
boot_volume
str		FalseThe volume used for boot.
boot_cdrom
str		FalseThe CDROM used for boot.
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['running', 'stopped', 'absent', 'present', 'update']