Module types/output

namespace blockstorage

namespace compute

namespace containerinfra

namespace database

namespace identity

namespace keymanager

namespace loadbalancer

namespace networking

namespace objectstorage

namespace orchestration

namespace sharedfilesystem

namespace vpnaas

namespace blockstorage

interface VolumeAttachment

interface VolumeAttachment

property device

device: string;

property id

id: string;

property instanceId

instanceId: string;

interface VolumeSchedulerHint

interface VolumeSchedulerHint

property additionalProperties

additionalProperties?: undefined | {[key: string]: any};

Arbitrary key/value pairs of additional properties to pass to the scheduler.

property differentHosts

differentHosts?: string[];

The volume should be scheduled on a different host from the set of volumes specified in the list provided.

property localToInstance

localToInstance?: undefined | string;

An instance UUID. The volume should be scheduled on the same host as the instance.

property query

query?: undefined | string;

A conditional query that a back-end must pass in order to host a volume. The query must use the JsonFilter syntax which is described here. At this time, only simple queries are supported. Compound queries using and, or, or not are not supported. An example of a simple query is:

property sameHosts

sameHosts?: string[];

A list of volume UUIDs. The volume should be scheduled on the same host as another volume specified in the list provided.

interface VolumeV1Attachment

interface VolumeV1Attachment

property device

device: string;

property id

id: string;

property instanceId

instanceId: string;

interface VolumeV2Attachment

interface VolumeV2Attachment

property device

device: string;

property id

id: string;

property instanceId

instanceId: string;

interface VolumeV2SchedulerHint

interface VolumeV2SchedulerHint

property additionalProperties

additionalProperties?: undefined | {[key: string]: any};

Arbitrary key/value pairs of additional properties to pass to the scheduler.

property differentHosts

differentHosts?: string[];

The volume should be scheduled on a different host from the set of volumes specified in the list provided.

property localToInstance

localToInstance?: undefined | string;

An instance UUID. The volume should be scheduled on the same host as the instance.

property query

query?: undefined | string;

A conditional query that a back-end must pass in order to host a volume. The query must use the JsonFilter syntax which is described here. At this time, only simple queries are supported. Compound queries using and, or, or not are not supported. An example of a simple query is:

property sameHosts

sameHosts?: string[];

A list of volume UUIDs. The volume should be scheduled on the same host as another volume specified in the list provided.

namespace compute

interface InstanceBlockDevice

interface InstanceBlockDevice

property bootIndex

bootIndex?: undefined | number;

The boot index of the volume. It defaults to 0. Changing this creates a new server.

property deleteOnTermination

deleteOnTermination?: undefined | false | true;

Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.

property destinationType

destinationType?: undefined | string;

The type that gets created. Possible values are “volume” and “local”. Changing this creates a new server.

property deviceType

deviceType?: undefined | string;

The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.

property diskBus

diskBus?: undefined | string;

The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.

property guestFormat

guestFormat?: undefined | string;

property sourceType

sourceType: string;

The source type of the device. Must be one of “blank”, “image”, “volume”, or “snapshot”. Changing this creates a new server.

property uuid

uuid?: undefined | string;

The UUID of the image, volume, or snapshot. Changing this creates a new server.

property volumeSize

volumeSize?: undefined | number;

The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.

property volumeType

volumeType?: undefined | string;

The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.

interface InstanceNetwork

interface InstanceNetwork

property accessNetwork

accessNetwork?: undefined | false | true;

Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.

property fixedIpV4

fixedIpV4: string;

Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.

property fixedIpV6

fixedIpV6: string;

property mac

mac: string;

property name

name: string;

The human-readable name of the network. Changing this creates a new server.

property port

port: string;

The port UUID of a network to attach to the server. Changing this creates a new server.

property uuid

uuid: string;

The UUID of the image, volume, or snapshot. Changing this creates a new server.

interface InstancePersonality

interface InstancePersonality

property content

content: string;

The contents of the file. Limited to 255 bytes.

property file

file: string;

The absolute path of the destination file.

interface InstanceSchedulerHint

interface InstanceSchedulerHint

property additionalProperties

additionalProperties?: undefined | {[key: string]: any};

Arbitrary key/value pairs of additional properties to pass to the scheduler.

property buildNearHostIp

buildNearHostIp?: undefined | string;

An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.

property differentHosts

differentHosts?: string[];

A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.

property group

group?: undefined | string;

A UUID of a Server Group. The instance will be placed into that group.

property queries

queries?: string[];

A conditional query that a compute node must pass in order to host an instance. The query must use the JsonFilter syntax which is described here. At this time, only simple queries are supported. Compound queries using and, or, or not are not supported. An example of a simple query is:

property sameHosts

sameHosts?: string[];

A list of instance UUIDs. The instance will be scheduled on the same host of those specified.

property targetCell

targetCell?: undefined | string;

The name of a cell to host the instance.

interface InstanceVendorOptions

interface InstanceVendorOptions

property detachPortsBeforeDestroy

detachPortsBeforeDestroy?: undefined | false | true;

Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.

property ignoreResizeConfirmation

ignoreResizeConfirmation?: undefined | false | true;

Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.

interface SecGroupRule

interface SecGroupRule

property cidr

cidr?: undefined | string;

Required if fromGroupId or self is empty. The IP range that will be the source of network traffic to the security group. Use 0.0.0.0/0 to allow all IP addresses. Changing this creates a new security group rule. Cannot be combined with fromGroupId or self.

property fromGroupId

fromGroupId?: undefined | string;

Required if cidr or self is empty. The ID of a group from which to forward traffic to the parent group. Changing this creates a new security group rule. Cannot be combined with cidr or self.

property fromPort

fromPort: number;

An integer representing the lower bound of the port range to open. Changing this creates a new security group rule.

property id

id: string;

property ipProtocol

ipProtocol: string;

The protocol type that will be allowed. Changing this creates a new security group rule.

property self

self?: undefined | false | true;

Required if cidr and fromGroupId is empty. If true, the security group itself will be added as a source to this ingress rule. Cannot be combined with cidr or fromGroupId.

property toPort

toPort: number;

An integer representing the upper bound of the port range to open. Changing this creates a new security group rule.

namespace containerinfra

interface ClusterKubeconfig

interface ClusterKubeconfig

property clientCertificate

clientCertificate: string;

property clientKey

clientKey: string;

property clusterCaCertificate

clusterCaCertificate: string;

property host

host: string;

property rawConfig

rawConfig: string;

namespace database

interface ConfigurationConfiguration

interface ConfigurationConfiguration

property name

name: string;

Configuration parameter name. Changing this creates a new resource.

property value

value: string;

Configuration parameter value. Changing this creates a new resource.

interface ConfigurationDatastore

interface ConfigurationDatastore

property type

type: string;

Database engine type to be used with this configuration. Changing this creates a new resource.

property version

version: string;

Version of database engine type to be used with this configuration. Changing this creates a new resource.

interface InstanceDatabase

interface InstanceDatabase

property charset

charset?: undefined | string;

Database character set. Changing this creates a new instance.

property collate

collate?: undefined | string;

Database collation. Changing this creates a new instance.

property name

name: string;

Database to be created on new instance. Changing this creates a new instance.

interface InstanceDatastore

interface InstanceDatastore

property type

type: string;

Database engine type to be used in new instance. Changing this creates a new instance.

property version

version: string;

Version of database engine type to be used in new instance. Changing this creates a new instance.

interface InstanceNetwork

interface InstanceNetwork

property fixedIpV4

fixedIpV4?: undefined | string;

Specifies a fixed IPv4 address to be used on this network. Changing this creates a new instance.

property fixedIpV6

fixedIpV6?: undefined | string;

Specifies a fixed IPv6 address to be used on this network. Changing this creates a new instance.

property port

port?: undefined | string;

The port UUID of a network to attach to the instance. Changing this creates a new instance.

property uuid

uuid?: undefined | string;

The network UUID to attach to the instance. Changing this creates a new instance.

interface InstanceUser

interface InstanceUser

property databases

databases?: string[];

A list of databases that user will have access to. If not specified, user has access to all databases on th einstance. Changing this creates a new instance.

property host

host?: undefined | string;

An ip address or % sign indicating what ip addresses can connect with this user credentials. Changing this creates a new instance.

property name

name: string;

Database to be created on new instance. Changing this creates a new instance.

property password

password?: undefined | string;

User’s password. Changing this creates a new instance.

namespace identity

interface ApplicationCredentialAccessRule

interface ApplicationCredentialAccessRule

property id

id: string;

The ID of the existing access rule. The access rule ID of another application credential can be provided.

property method

method: string;

The request method that the application credential is permitted to use for a given API endpoint. Allowed values: POST, GET, HEAD, PATCH, PUT and DELETE.

property path

path: string;

The API path that the application credential is permitted to access. May use named wildcards such as {tag} or the unnamed wildcard * to match against any string in the path up to a /, or the recursive wildcard ** to include / in the matched path.

property service

service: string;

The service type identifier for the service that the application credential is granted to access. Must be a service type that is listed in the service catalog and not a code name for a service. E.g. identity, compute, volumev3, image, network, object-store, sharev2, dns, key-manager, monitoring, etc.

interface GetAuthScopeRole

interface GetAuthScopeRole

property roleId

roleId: string;

The ID of the role.

property roleName

roleName: string;

The name of the role.

interface UserMultiFactorAuthRule

interface UserMultiFactorAuthRule

property rules

rules: string[];

A list of authentication plugins that the user must authenticate with.

namespace keymanager

interface ContainerV1Acl

interface ContainerV1Acl

property read

read: ContainerV1AclRead;

interface ContainerV1AclRead

interface ContainerV1AclRead

property createdAt

createdAt: string;

The date the container ACL was created.

property projectAccess

projectAccess?: undefined | false | true;

Whether the container is accessible project wide. Defaults to true.

property updatedAt

updatedAt: string;

The date the container ACL was last updated.

property users

users?: string[];

The list of user IDs, which are allowed to access the container, when projectAccess is set to false.

interface ContainerV1Consumer

interface ContainerV1Consumer

property name

name?: undefined | string;

The name of the secret reference. The reference names must correspond the container type, more details are available here.

property url

url?: undefined | string;

The consumer URL.

interface ContainerV1SecretRef

interface ContainerV1SecretRef

property name

name?: undefined | string;

The name of the secret reference. The reference names must correspond the container type, more details are available here.

property secretRef

secretRef: string;

The secret reference / where to find the secret, URL.

interface GetContainerAcl

interface GetContainerAcl

property read

read: GetContainerAclRead;

interface GetContainerAclRead

interface GetContainerAclRead

property createdAt

createdAt: string;

The date the container ACL was created.

property projectAccess

projectAccess?: undefined | false | true;

Whether the container is accessible project wide.

property updatedAt

updatedAt: string;

The date the container ACL was last updated.

property users

users?: string[];

The list of user IDs, which are allowed to access the container, when projectAccess is set to false.

interface GetContainerConsumer

interface GetContainerConsumer

property name

name?: undefined | string;

The Container name.

property url

url?: undefined | string;

The consumer URL.

interface GetContainerSecretRef

interface GetContainerSecretRef

property name

name?: undefined | string;

The Container name.

property secretRef

secretRef?: undefined | string;

The secret reference / where to find the secret, URL.

interface GetSecretAcl

interface GetSecretAcl

property read

read: GetSecretAclRead;

interface GetSecretAclRead

interface GetSecretAclRead

property createdAt

createdAt: string;

The date the secret ACL was created.

property projectAccess

projectAccess?: undefined | false | true;

Whether the secret is accessible project wide.

property updatedAt

updatedAt: string;

The date the secret ACL was last updated.

property users

users?: string[];

The list of user IDs, which are allowed to access the secret, when projectAccess is set to false.

interface OrderV1Meta

interface OrderV1Meta

property algorithm

algorithm: string;

Algorithm to use for key generation.

property bitLength

bitLength: number;
  • Bit lenght of key to be generated.

property expiration

expiration?: undefined | string;

This is a UTC timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. If set, the secret will not be available after this time.

property mode

mode?: undefined | string;

The mode to use for key generation.

property name

name?: undefined | string;

The name of the secret set by the user.

property payloadContentType

payloadContentType?: undefined | string;

The media type for the content of the secrets payload. Must be one of text/plain, text/plain;charset=utf-8, text/plain; charset=utf-8, application/octet-stream, application/pkcs8.

interface SecretV1Acl

interface SecretV1Acl

property read

read: SecretV1AclRead;

interface SecretV1AclRead

interface SecretV1AclRead

property createdAt

createdAt: string;

The date the secret ACL was created.

property projectAccess

projectAccess?: undefined | false | true;

Whether the secret is accessible project wide. Defaults to true.

property updatedAt

updatedAt: string;

The date the secret ACL was last updated.

property users

users?: string[];

The list of user IDs, which are allowed to access the secret, when projectAccess is set to false.

namespace loadbalancer

interface MembersMember

interface MembersMember

property address

address: string;

The IP address of the members to receive traffic from the load balancer.

property adminStateUp

adminStateUp?: undefined | false | true;

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

property id

id: string;

The unique ID for the members.

property name

name?: undefined | string;

Human-readable name for the member.

property protocolPort

protocolPort: number;

The port on which to listen for client traffic.

property subnetId

subnetId?: undefined | string;

The subnet in which to access the member.

property weight

weight?: undefined | number;

A positive integer value that indicates the relative portion of traffic that this members should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.

interface PoolPersistence

interface PoolPersistence

property cookieName

cookieName?: undefined | string;

The name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.

property type

type: string;

The type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.

namespace networking

interface GetPortAllowedAddressPair

interface GetPortAllowedAddressPair

property ipAddress

ipAddress: string;

The additional IP address.

property macAddress

macAddress: string;

The MAC address of the port.

interface GetPortBinding

interface GetPortBinding

property hostId

hostId: string;

The ID of the host, which has the allocatee port.

property profile

profile: string;

A JSON string containing the binding profile information.

property vifDetails

vifDetails: {[key: string]: any};

A map of JSON strings containing additional details for this specific binding.

property vifType

vifType: string;

The VNIC type of the port binding.

property vnicType

vnicType: string;

VNIC type for the port.

interface GetPortExtraDhcpOption

interface GetPortExtraDhcpOption

property ipVersion

ipVersion: number;

IP protocol version

property name

name: string;

The name of the port.

property value

value: string;

Value of the DHCP option.

interface GetRouterExternalFixedIp

interface GetRouterExternalFixedIp

property ipAddress

ipAddress?: undefined | string;

The IP address to set on the router.

property subnetId

subnetId?: undefined | string;

interface GetSubnetAllocationPool

interface GetSubnetAllocationPool

property end

end: string;

property start

start: string;

interface GetSubnetHostRoute

interface GetSubnetHostRoute

property destinationCidr

destinationCidr: string;

property nextHop

nextHop: string;

interface GetTrunkSubPort

interface GetTrunkSubPort

property portId

portId: string;

The ID of the trunk parent port.

property segmentationId

segmentationId: number;

The numeric id of the subport segment.

property segmentationType

segmentationType: string;

The segmenation tecnology used, e.g., “vlan”.

interface NetworkSegment

interface NetworkSegment

property networkType

networkType?: undefined | string;

The type of physical network.

property physicalNetwork

physicalNetwork?: undefined | string;

The physical network where this network is implemented.

property segmentationId

segmentationId?: undefined | number;

An isolated segment on the physical network.

interface PortAllowedAddressPair

interface PortAllowedAddressPair

property ipAddress

ipAddress: string;

The additional IP address.

property macAddress

macAddress?: undefined | string;

The additional MAC address.

interface PortBinding

interface PortBinding

property hostId

hostId?: undefined | string;

The ID of the host to allocate port on.

property profile

profile?: undefined | string;

Custom data to be passed as binding:profile. Data must be passed as JSON.

property vifDetails

vifDetails: {[key: string]: any};

A map of JSON strings containing additional details for this specific binding.

property vifType

vifType: string;

The VNIC type of the port binding.

property vnicType

vnicType?: undefined | string;

VNIC type for the port. Can either be direct, direct-physical, macvtap, normal, baremetal or virtio-forwarder. Default value is normal.

interface PortExtraDhcpOption

interface PortExtraDhcpOption

property ipVersion

ipVersion?: undefined | number;

IP protocol version. Defaults to 4.

property name

name: string;

Name of the DHCP option.

property value

value: string;

Value of the DHCP option.

interface PortFixedIp

interface PortFixedIp

property ipAddress

ipAddress?: undefined | string;

The additional IP address.

property subnetId

subnetId: string;

Subnet in which to allocate IP address for this port.

interface RouterExternalFixedIp

interface RouterExternalFixedIp

property ipAddress

ipAddress: string;

The IP address to set on the router.

property subnetId

subnetId?: undefined | string;

Subnet in which the fixed IP belongs to.

interface RouterVendorOptions

interface RouterVendorOptions

property setRouterGatewayAfterCreate

setRouterGatewayAfterCreate?: undefined | false | true;

Boolean to control whether the Router gateway is assigned during creation or updated after creation.

interface SubnetAllocationPool

interface SubnetAllocationPool

property end

end: string;

The ending address.

property start

start: string;

The starting address.

interface SubnetAllocationPoolsCollection

interface SubnetAllocationPoolsCollection

property end

end: string;

The ending address.

property start

start: string;

The starting address.

interface SubnetHostRoute

interface SubnetHostRoute

property destinationCidr

destinationCidr: string;

The destination CIDR.

property nextHop

nextHop: string;

The next hop in the route.

interface TrunkSubPort

interface TrunkSubPort

property portId

portId: string;

The ID of the port to be made a subport of the trunk.

property segmentationId

segmentationId: number;

The numeric id of the subport segment.

property segmentationType

segmentationType: string;

The segmentation technology to use, e.g., “vlan”.

namespace objectstorage

interface ContainerVersioning

interface ContainerVersioning

property location

location: string;

Container in which versions will be stored.

property type

type: string;

Versioning type which can be versions or history according to Openstack documentation.

namespace orchestration

interface StackV1Output

interface StackV1Output

property description

description: string;

The description of the stack resource.

property outputKey

outputKey: string;

property outputValue

outputValue: string;

namespace sharedfilesystem

interface GetShareExportLocation

interface GetShareExportLocation

property path

path: string;

property preferred

preferred: string;

interface ShareExportLocation

interface ShareExportLocation

property path

path: string;

property preferred

preferred: string;

namespace vpnaas

interface IkePolicyLifetime

interface IkePolicyLifetime

property units

units: string;

property value

value: number;

interface IpSecPolicyLifetime

interface IpSecPolicyLifetime

property units

units: string;

property value

value: number;

interface SiteConnectionDpd

interface SiteConnectionDpd

property action

action: string;

property interval

interval: number;

property timeout

timeout: number;