Struct ServerBuilder

pub struct ServerBuilder<'a> { /* private fields */ }

Builder for Server.

Implementations

impl<'a> ServerBuilder<'a>

pub fn access_ipv4<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

IPv4 address that should be used to access this server.

pub fn access_ipv6<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

IPv6 address that should be used to access this server.

pub fn admin_pass<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

The administrative password of the server. If you omit this parameter, the operation generates a new password.

pub fn availability_zone<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

A target cell name. Schedule the server in a host in the cell specified. It is available when TargetCellFilter is available on cloud side that is cell v1 environment.

pub fn block_device_mapping<VALUE: Into<Vec<BlockDeviceMapping<'a>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn block_device_mapping_v2<VALUE: Into<Vec<BlockDeviceMappingV2<'a>>>>( &mut self, value: VALUE, ) -> &mut Self

Enables fine grained control of the block device mapping for an instance. This is typically used for booting servers from volumes. An example format would look as follows:

"block_device_mapping_v2": [{
    "boot_index": "0",
    "uuid": "ac408821-c95a-448f-9292-73986c790911",
    "source_type": "image",
    "volume_size": "25",
    "destination_type": "volume",
    "delete_on_termination": true,
    "tag": "disk1",
    "disk_bus": "scsi"}]

In microversion 2.32, tag is an optional string attribute that can be used to assign a tag to the block device. This tag is then exposed to the guest in the metadata API and the config drive and is associated to hardware metadata for that block device, such as bus (ex: SCSI), bus address (ex: 1:0:2:0), and serial.

A bug has caused the tag attribute to no longer be accepted starting with version 2.33. It has been restored in version 2.42.

pub fn config_drive<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Indicates whether a config drive enables metadata injection. The config_drive setting provides information about a drive that the instance can mount at boot time. The instance reads files from the drive to get information that is normally available through the metadata service. This metadata is different from the user data. Not all cloud providers enable the config_drive. Read more in the OpenStack End User Guide.

pub fn description<VALUE: Into<Option<Cow<'a, str>>>>( &mut self, value: VALUE, ) -> &mut Self

A free form description of the server. Limited to 255 characters in length. Before microversion 2.19 this was set to the server name.

New in version 2.19

pub fn flavor_ref<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

The flavor reference, as an ID (including a UUID) or full URL, for the flavor for your server instance.

pub fn image_ref<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

The UUID of the image to use for your server instance. This is not required in case of boot from volume. In all other cases it is required and must be a valid UUID otherwise API will return 400.

pub fn key_name<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

A target cell name. Schedule the server in a host in the cell specified. It is available when TargetCellFilter is available on cloud side that is cell v1 environment.

pub fn max_count<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

pub fn min_count<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

pub fn name<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

A target cell name. Schedule the server in a host in the cell specified. It is available when TargetCellFilter is available on cloud side that is cell v1 environment.

pub fn networks<VALUE: Into<ServerNetworks<'a>>>( &mut self, value: VALUE, ) -> &mut Self

A list of network object. Required parameter when there are multiple networks defined for the tenant. When you do not specify the networks parameter, the server attaches to the only network created for the current tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the uuid attribute in a networks object. To provision the server instance with a NIC for an already existing port, specify the port-id in the port attribute in a networks object.

If multiple networks are defined, the order in which they appear in the guest operating system will not necessarily reflect the order in which they are given in the server boot request. Guests should therefore not depend on device order to deduce any information about their network devices. Instead, device role tags should be used: introduced in 2.32, broken in 2.37, and re-introduced and fixed in 2.42, the tag is an optional, string attribute that can be used to assign a tag to a virtual network interface. This tag is then exposed to the guest in the metadata API and the config drive and is associated to hardware metadata for that network interface, such as bus (ex: PCI), bus address (ex: 0000:00:02.0), and MAC address.

A bug has caused the tag attribute to no longer be accepted starting with version 2.37. Therefore, network interfaces could only be tagged in versions 2.32 to 2.36 inclusively. Version 2.42 has restored the tag attribute.

Starting with microversion 2.37, this field is required and the special string values auto and none can be specified for networks. auto tells the Compute service to use a network that is available to the project, if one exists. If one does not exist, the Compute service will attempt to automatically allocate a network for the project (if possible). none tells the Compute service to not allocate a network for the instance. The auto and none values cannot be used with any other network values, including other network uuids, ports, fixed IPs or device tags. These are requested as strings for the networks value, not in a list. See the associated example.

pub fn os_dcf_disk_config(&mut self, value: OsDcfDiskConfig) -> &mut Self

Controls how the API partitions the disk when you create, rebuild, or resize servers. A server inherits the OS-DCF:diskConfig value from the image from which it was created, and an image inherits the OS-DCF:diskConfig value from the server from which it was created. To override the inherited setting, you can include this attribute in the request body of a server create, rebuild, or resize request. If the OS-DCF:diskConfig value for an image is MANUAL, you cannot create a server from that image and set its OS-DCF:diskConfig value to AUTO. A valid value is:

• AUTO. The API builds the server with a single partition the size of the target flavor disk. The API automatically adjusts the file system to fit the entire partition.
• MANUAL. The API builds the server by using whatever partition scheme and file system is in the source image. If the target flavor disk is larger, the API does not partition the remaining disk space.

pub fn return_reservation_id<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Indicates whether a config drive enables metadata injection. The config_drive setting provides information about a drive that the instance can mount at boot time. The instance reads files from the drive to get information that is normally available through the metadata service. This metadata is different from the user data. Not all cloud providers enable the config_drive. Read more in the OpenStack End User Guide.

pub fn security_groups<VALUE: Into<Vec<SecurityGroups<'a>>>>( &mut self, value: VALUE, ) -> &mut Self

One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group. Requested security groups are not applied to pre-existing ports.

pub fn tags<VALUE: Into<Vec<Cow<'a, str>>>>( &mut self, value: VALUE, ) -> &mut Self

A list of tags. Tags have the following restrictions:

• Tag is a Unicode bytestring no longer than 60 characters.
• Tag is a non-empty string.
• ‘/’ is not allowed to be in a tag name
• Comma is not allowed to be in a tag name in order to simplify requests that specify lists of tags
• All other characters are allowed to be in a tag name
• Each server can have up to 50 tags.

New in version 2.52

pub fn trusted_image_certificates<VALUE: Into<Vec<Cow<'a, str>>>>( &mut self, value: VALUE, ) -> &mut Self

A list of trusted certificate IDs, which are used during image signature verification to verify the signing certificate. The list is restricted to a maximum of 50 IDs. This parameter is optional in server create requests if allowed by policy, and is not supported for volume-backed instances.

New in version 2.63

pub fn user_data<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE, ) -> &mut Self

Configuration information or scripts to use upon launch. Must be Base64 encoded. Restricted to 65535 bytes.

Note

The null value allowed in Nova legacy v2 API, but due to the strict input validation, it isn’t allowed in Nova v2.1 API.

pub fn build(&self) -> Result<Server<'a>, ServerBuilderError>

Builds a new Server.

Errors

If a required field has not been initialized.

impl<'a> ServerBuilder<'a>

pub fn metadata<I, K, V>(&mut self, iter: I) -> &mut Self

where I: Iterator<Item = (K, V)>, K: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.

Trait Implementations

impl<'a> Clone for ServerBuilder<'a>

fn clone(&self) -> ServerBuilder<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Default for ServerBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.