community.general.hwc_ecs_instance module – Creates a resource of Ecs/Instance in Huawei Cloud
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.hwc_ecs_instance
.
New in community.general 0.2.0
Synopsis
instance management.
Aliases: cloud.huawei.hwc_ecs_instance
Requirements
The below requirements are needed on the host that executes this module.
keystoneauth1 >= 3.6.0
Parameters
Parameter |
Comments |
---|---|
Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. Password complexity requirements, consists of 8 to 26 characters. The password must contain at least three of the following character types ‘uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?)’. The password cannot contain the username or the username in reverse. The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username. |
|
Specifies the name of the AZ where the ECS is located. |
|
Specifies the data disks of ECS instance. |
|
Specifies the disk device name. |
|
Specifies the disk ID. |
|
Specifies the description of an ECS, which is a null string by default. Can contain a maximum of 85 characters. Cannot contain special characters, such as < and >. |
|
The name of the Domain to scope to (Identity v3). Currently only domain names are supported, and not domain IDs. |
|
Specifies the ID of the elastic IP address assigned to the ECS. Only elastic IP addresses in the DOWN state can be assigned. |
|
Specifies whether automatic recovery is enabled on the ECS. Choices:
|
|
Specifies the ID of the enterprise project to which the ECS belongs. |
|
Specifies the name of the system flavor. |
|
The ID of resource to be managed. |
|
The Identity authentication URL. |
|
Specifies the ID of the system image. |
|
Specifies the ECS name. Value requirements consists of 1 to 64 characters, including letters, digits, underscores ( |
|
Specifies the NIC information of the ECS. Constraints the network of the NIC must belong to the VPC specified by vpc_id. A maximum of 12 NICs can be attached to an ECS. |
|
Specifies the IP address of the NIC. The value is an IPv4 address. Its value must be an unused IP address in the network segment of the subnet. |
|
Specifies the ID of subnet. |
|
The password to login with. |
|
The name of the Tenant (Identity v2) or Project (Identity v3). Currently only project names are supported, and not project IDs. |
|
The region to which the project belongs. |
|
Specifies the configuration of the ECS’s system disks. |
|
Specifies the system disk size, in GB. The value range is 1 to 1024. The system disk size must be greater than or equal to the minimum system disk size supported by the image (min_disk attribute of the image). If this parameter is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image (min_disk attribute of the image). |
|
Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image. |
|
Specifies the ECS system disk type. SATA is common I/O disk type. SAS is high I/O disk type. SSD is ultra-high I/O disk type. co-p1 is high I/O (performance-optimized I) disk type. uh-l1 is ultra-high I/O (latency-optimized) disk type. NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks. |
|
Specifies the security groups of the ECS. If this parameter is left blank, the default security group is bound to the ECS by default. |
|
Specifies the metadata of ECS to be created. |
|
Specifies the tags of an ECS. When you create ECSs, one ECS supports up to 10 tags. |
|
Specifies the name of the SSH key used for logging in to the ECS. |
|
Whether the given object should exist in Huawei Cloud. Choices:
|
|
The timeouts for each operations. Default: |
|
The timeouts for create operation. Default: |
|
The timeouts for delete operation. Default: |
|
The timeouts for update operation. Default: |
|
The user name to login with. Currently only user names are supported, and not user IDs. |
|
Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected. The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB. For Linux ECSs, this parameter does not take effect when adminPass is used. |
|
Specifies the ID of the VPC to which the ECS belongs. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
For authentication, you can set identity_endpoint using the
ANSIBLE_HWC_IDENTITY_ENDPOINT
environment variable.For authentication, you can set user using the
ANSIBLE_HWC_USER
environment variable.For authentication, you can set password using the
ANSIBLE_HWC_PASSWORD
environment variable.For authentication, you can set domain using the
ANSIBLE_HWC_DOMAIN
environment variable.For authentication, you can set project using the
ANSIBLE_HWC_PROJECT
environment variable.For authentication, you can set region using the
ANSIBLE_HWC_REGION
environment variable.Environment variables values will only be used if the playbook values are not set.
Examples
# create an ecs instance
- name: Create a vpc
hwc_network_vpc:
cidr: "192.168.100.0/24"
name: "ansible_network_vpc_test"
register: vpc
- name: Create a subnet
hwc_vpc_subnet:
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: true
vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26"
register: subnet
- name: Create a eip
hwc_vpc_eip:
dedicated_bandwidth:
charge_mode: "traffic"
name: "ansible_test_dedicated_bandwidth"
size: 1
type: "5_bgp"
register: eip
- name: Create a disk
hwc_evs_disk:
availability_zone: "cn-north-1a"
name: "ansible_evs_disk_test"
volume_type: "SATA"
size: 10
register: disk
- name: Create an instance
community.general.hwc_ecs_instance:
data_volumes:
- volume_id: "{{ disk.id }}"
enable_auto_recovery: false
eip_id: "{{ eip.id }}"
name: "ansible_ecs_instance_test"
availability_zone: "cn-north-1a"
nics:
- subnet_id: "{{ subnet.id }}"
ip_address: "192.168.100.33"
- subnet_id: "{{ subnet.id }}"
ip_address: "192.168.100.34"
server_tags:
my_server: "my_server"
image_id: "8da46d6d-6079-4e31-ad6d-a7167efff892"
flavor_name: "s3.small.1"
vpc_id: "{{ vpc.id }}"
root_volume:
volume_type: "SAS"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. Password complexity requirements consists of 8 to 26 characters. The password must contain at least three of the following character types “uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?)”. The password cannot contain the username or the username in reverse. The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username. Returned: success |
|
Specifies the name of the AZ where the ECS is located. Returned: success |
|
Specifies the configuration driver. Returned: success |
|
Specifies the time when an ECS was created. Returned: success |
|
Specifies the data disks of ECS instance. Returned: success |
|
Specifies the disk device name. Returned: success |
|
Specifies the disk ID. Returned: success |
|
Specifies the description of an ECS, which is a null string by default. Can contain a maximum of 85 characters. Cannot contain special characters, such as < and >. Returned: success |
|
Specifies the disk configuration type. MANUAL is The image space is not expanded. AUTO is the image space of the system disk will be expanded to be as same as the flavor. Returned: success |
|
Specifies the ID of the elastic IP address assigned to the ECS. Only elastic IP addresses in the DOWN state can be assigned. Returned: success |
|
Specifies whether automatic recovery is enabled on the ECS. Returned: success |
|
Specifies the ID of the enterprise project to which the ECS belongs. Returned: success |
|
Specifies the name of the system flavor. Returned: success |
|
Specifies the host name of the ECS. Returned: success |
|
Specifies the ID of the system image. Returned: success |
|
Specifies the image name of the ECS. Returned: success |
|
Specifies the ECS name. Value requirements “Consists of 1 to 64 characters, including letters, digits, underscores ( Returned: success |
|
Specifies the NIC information of the ECS. The network of the NIC must belong to the VPC specified by vpc_id. A maximum of 12 NICs can be attached to an ECS. Returned: success |
|
Specifies the IP address of the NIC. The value is an IPv4 address. Its value must be an unused IP address in the network segment of the subnet. Returned: success |
|
Specifies the port ID corresponding to the IP address. Returned: success |
|
Specifies the ID of subnet. Returned: success |
|
Specifies the power status of the ECS. Returned: success |
|
Specifies the configuration of the ECS’s system disks. Returned: success |
|
Specifies the disk device name. Returned: success |
|
Specifies the system disk size, in GB. The value range is 1 to 1024. The system disk size must be greater than or equal to the minimum system disk size supported by the image (min_disk attribute of the image). If this parameter is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image (min_disk attribute of the image). Returned: success |
|
Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image. Returned: success |
|
Specifies the disk ID. Returned: success |
|
Specifies the ECS system disk type. SATA is common I/O disk type. SAS is high I/O disk type. SSD is ultra-high I/O disk type. co-p1 is high I/O (performance-optimized I) disk type. uh-l1 is ultra-high I/O (latency-optimized) disk type. NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks. Returned: success |
|
Specifies the security groups of the ECS. If this parameter is left blank, the default security group is bound to the ECS by default. Returned: success |
|
Specifies the ECS alias. Returned: success |
|
Specifies the metadata of ECS to be created. Returned: success |
|
Specifies the tags of an ECS. When you create ECSs, one ECS supports up to 10 tags. Returned: success |
|
Specifies the name of the SSH key used for logging in to the ECS. Returned: success |
|
Specifies the ECS status. Options are ACTIVE, REBOOT, HARD_REBOOT, REBUILD, MIGRATING, BUILD, SHUTOFF, RESIZE, VERIFY_RESIZE, ERROR, and DELETED. Returned: success |
|
Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected. The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB. For Linux ECSs, this parameter does not take effect when adminPass is used. Returned: success |
|
Specifies the ID of the VPC to which the ECS belongs. Returned: success |