IBM::SoftLayer::Server

This resource type represents a server on SoftLayer. It extends the type OS::Nova::Server.
Table 1. Properties
Name Type Required Description
admin_pass String False The administrator password for the SoftLayer server.
admin_user String False Name of the administrative user to use on the SoftLayer server. This property will be removed from Juno in favor of the default cloud-init user that is set up for each image (for example, "ubuntu" for Ubuntu 12.04+, "fedora" for Fedora 19+ and "cloud-user" for CentOS/Red Hat Enterprise Linux 6.5).
availability_zone String False Name of the availability zone for SoftLayer server placement.
block_device_mapping List False Block device mappings for this SoftLayer server.
config_drive String False Value for config drive either boolean, or volume-id.
diskConfig String False Controls how the disk is partitioned when the server is created. Valid values are AUTO and MANUAL.
flavor String True The ID or name of the flavor to boot onto.
flavor_update_policy String False Policy governing how to apply a flavor update; either by requesting a server resize or by replacing the entire SoftLayer server. Valid values are RESIZE and REPLACE.
image String False The ID or name of the image to boot with.
image_update_policy String False Policy governing how to apply an image-id update; either by requesting a server rebuild or by replacing the entire SoftLayer server. Valid values are
  • REPLACE (the default)
  • REBUILD
  • REBUILD_PRESERVE_EPHEMERAL
key_name String False Name of key pair to inject into the SoftLayer server.
metadata Map False Arbitrary key/value metadata to store for this SoftLayer server. Both keys and values must be 255 characters or less. Non-string values are serialized to JSON (and the serialized string must be 255 characters or less).
name String False SoftLayer server name.
networks List False An ordered list of NICs to be added to this SoftLayer server, with information about connected networks, fixed IP addresses, and ports.
personality Map False A map of files to create or overwrite on the SoftLayer server at boot time. Keys are file names and values are the file contents.
reservation_id String False A UUID for the set of SoftLayer servers requested.
scheduler_hints String False Arbitrary key-value pairs that are specified by the client to help boot a SoftLayer server.
security_groups List False List of security group names or IDs. Cannot be used if Neutron ports are associated with this SoftLayer server; assign security groups to the ports instead.
software_config_transport String False Specifies how the SoftLayer server receives the metadata that is required for software configuration. POLL_SERVER_CFN allows calls to the Cloud Formation API action DescribeStackResource authenticated with the provided key pair. POLL_SERVER_HEAT allows calls to the Heat API action resource-show by using the provided keystone credentials.
user_data String False User data script to be run by cloud-init.
user_data_format String False How the user_data is formatted for the SoftLayer server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW, the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG, the user_data is bundled as part of the software configuration data, and metadata is derived from any associated SoftwareDeployment resources.
Table 2. Custom properties
Name Type Required Description
hourly String False Specify the SoftLayer server billing interval, hourly (default) or monthly.
datacenter String False Specify the short name of the data center in which the VS should reside.
dedicated String False Specify where the SoftLayer server should be housed, on a shared host (default) or dedicated host. Specifying a dedicated host will incur a fee on your account.
disk_type String False Specify if the SoftLayer server uses a local disk or SAN.
Table 3. Attributes
Name Description
accessIPv4 The manually assigned alternative public IPv4 address of the SoftLayer server.
accessIPv6 The manually assigned alternative public IPv6 address of the SoftLayer server.
addresses A dict of all network addresses with corresponding port_id values.
first_address A convenience attribute to fetch the first assigned network address or an empty string if nothing is assigned. The result might not be predictable if the SoftLayer server has addresses from more than one network.
instance_name The AWS compatible instance name.
name The name of the SoftLayer server.
networks A dict of assigned network addresses of the form: {\"public\": [ip1, ip2...], \"private\": [ip3, ip4]}.
passwords The user and passwords of the SoftLayer VM.
show A dict of all SoftLayer server details as returned by the API.
uuid The UUID of the virtual machine.

Feedback