OpenStack Resource Types

OS::Ceilometer::Alarm

Properties

alarm_actions : List

A list of URLs (webhooks) to invoke when state transitions to alarm

Optional property.

comparison_operator : String

Operator used to compare specified statistic with threshold

Required property.

Allowed values: ge, gt, eq, ne, lt, le

description : String

Description for the alarm

Optional property.

enabled : Boolean

True if alarm evaluation/actioning is enabled

Optional property, defaults to “true”.

evaluation_periods : String

Number of periods to evaluate over

Required property.

insufficient_data_actions : List

A list of URLs (webhooks) to invoke when state transitions to insufficient-data

Optional property.

matching_metadata : Map

Meter should match this resource metadata (key=value) additionally to the meter_name

Optional property.

meter_name : String

Meter name watched by the alarm

Required property.

ok_actions : List

A list of URLs (webhooks) to invoke when state transitions to ok

Optional property.

period : String

Period (seconds) to evaluate over

Required property.

repeat_actions : Boolean

True to trigger actions each time the threshold is reached. By default, actions are called when : the threshold is reached AND the alarm’s state have changed

Optional property, defaults to “false”.

statistic : String

Meter statistic to evaluate

Required property.

Allowed values: count, avg, sum, min, max

threshold : String

Threshold to evaluate against

Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Ceilometer::Alarm
    properties:
      alarm_actions: [Value, Value, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: String
      insufficient_data_actions: [Value, Value, ...]
      matching_metadata: {...}
      meter_name: String
      ok_actions: [Value, Value, ...]
      period: String
      repeat_actions: Boolean
      statistic: String
      threshold: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Ceilometer::Alarm
    Properties:
      alarm_actions: [Value, Value, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: String
      insufficient_data_actions: [Value, Value, ...]
      matching_metadata: {...}
      meter_name: String
      ok_actions: [Value, Value, ...]
      period: String
      repeat_actions: Boolean
      statistic: String
      threshold: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Ceilometer::Alarm",
      "Properties": {
        "alarm_actions": [Value, Value, ...],
        "comparison_operator": String,
        "description": String,
        "enabled": Boolean,
        "evaluation_periods": String,
        "insufficient_data_actions": [Value, Value, ...],
        "matching_metadata": {...},
        "meter_name": String,
        "ok_actions": [Value, Value, ...],
        "period": String,
        "repeat_actions": Boolean,
        "statistic": String,
        "threshold": String
      }
    }
  }
}

OS::Cinder::Volume

Properties

availability_zone : String

The availability zone in which the volume will be created.

Optional property.

backup_id : String

If specified, the backup to create the volume from.

Optional property.

description : String

A description of the volume.

Optional property.

image : String

If specified, the name or ID of the image to create the volume from.

Optional property.

imageRef : String

DEPRECATED: use “image” instead.

Optional property.

metadata : Map

Key/value pairs to associate with the volume.

Optional property.

name : String

A name used to distinguish the volume.

Optional property.

size : Number

The size of the volume in GB.

Optional property.

snapshot_id : String

If specified, the snapshot to create the volume from.

Optional property.

source_volid : String

If specified, the volume to use as source.

Optional property.

volume_type : String

If specified, the type of volume to use, mapping to a specific backend.

Optional property.

Attributes

availability_zone
The availability zone in which the volume is located.
bootable
Boolean indicating if the volume can be booted or not.
created_at
The timestamp indicating volume creation.
display_description
Description of the volume.
display_name
Name of the volume.
metadata
Key/value pairs associated with the volume.
size
The size of the volume in GB.
snapshot_id
The snapshot the volume was created from, if any.
source_volid
The volume used as source, if any.
status
The current status of the volume.
volume_type
The type of the volume mapping to a backend, if any.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Cinder::Volume
    properties:
      availability_zone: String
      backup_id: String
      description: String
      image: String
      imageRef: String
      metadata: {...}
      name: String
      size: Number
      snapshot_id: String
      source_volid: String
      volume_type: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Cinder::Volume
    Properties:
      availability_zone: String
      backup_id: String
      description: String
      image: String
      imageRef: String
      metadata: {...}
      name: String
      size: Number
      snapshot_id: String
      source_volid: String
      volume_type: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Cinder::Volume",
      "Properties": {
        "availability_zone": String,
        "backup_id": String,
        "description": String,
        "image": String,
        "imageRef": String,
        "metadata": {...},
        "name": String,
        "size": Number,
        "snapshot_id": String,
        "source_volid": String,
        "volume_type": String
      }
    }
  }
}

OS::Cinder::VolumeAttachment

Properties

instance_uuid : String

The ID of the server to which the volume attaches.

Required property.

mountpoint : String

The location where the volume is exposed on the instance.

Required property.

volume_id : String

The ID of the volume to be attached.

Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Cinder::VolumeAttachment
    properties:
      instance_uuid: String
      mountpoint: String
      volume_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Cinder::VolumeAttachment
    Properties:
      instance_uuid: String
      mountpoint: String
      volume_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Cinder::VolumeAttachment",
      "Properties": {
        "instance_uuid": String,
        "mountpoint": String,
        "volume_id": String
      }
    }
  }
}

OS::Heat::AccessPolicy

Properties

AllowedResources : List

Resources that users are allowed to access by the DescribeStackResource API.

Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Heat::AccessPolicy
    properties:
      AllowedResources: [Value, Value, ...]

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Heat::AccessPolicy
    Properties:
      AllowedResources: [Value, Value, ...]

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Heat::AccessPolicy",
      "Properties": {
        "AllowedResources": [Value, Value, ...]
      }
    }
  }
}

OS::Heat::CWLiteAlarm

Properties

AlarmActions : List

A list of actions to execute when state transitions to alarm.

Optional property.

AlarmDescription : String

Description for the alarm.

Optional property.

ComparisonOperator : String

Operator used to compare the specified Statistic with Threshold.

Optional property.

Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

Dimensions : List

A list of dimensions (arbitrary name/value pairs) associated with the metric.

Optional property.

EvaluationPeriods : String

Number of periods to evaluate over.

Optional property.

InsufficientDataActions : List

A list of actions to execute when state transitions to insufficient-data.

Optional property.

MetricName : String

Metric name watched by the alarm.

Optional property.

Namespace : String

Namespace for the metric.

Optional property.

OKActions : List

A list of actions to execute when state transitions to ok.

Optional property.

Period : String

Period (seconds) to evaluate over.

Optional property.

Statistic : String

Metric statistic to evaluate.

Optional property.

Allowed values: SampleCount, Average, Sum, Minimum, Maximum

Threshold : String

Threshold to evaluate against.

Optional property.

Units : String

Unit for the metric.

Optional property.

Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Heat::CWLiteAlarm
    properties:
      AlarmActions: [Value, Value, ...]
      AlarmDescription: String
      ComparisonOperator: String
      Dimensions: [Value, Value, ...]
      EvaluationPeriods: String
      InsufficientDataActions: [Value, Value, ...]
      MetricName: String
      Namespace: String
      OKActions: [Value, Value, ...]
      Period: String
      Statistic: String
      Threshold: String
      Units: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Heat::CWLiteAlarm
    Properties:
      AlarmActions: [Value, Value, ...]
      AlarmDescription: String
      ComparisonOperator: String
      Dimensions: [Value, Value, ...]
      EvaluationPeriods: String
      InsufficientDataActions: [Value, Value, ...]
      MetricName: String
      Namespace: String
      OKActions: [Value, Value, ...]
      Period: String
      Statistic: String
      Threshold: String
      Units: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Heat::CWLiteAlarm",
      "Properties": {
        "AlarmActions": [Value, Value, ...],
        "AlarmDescription": String,
        "ComparisonOperator": String,
        "Dimensions": [Value, Value, ...],
        "EvaluationPeriods": String,
        "InsufficientDataActions": [Value, Value, ...],
        "MetricName": String,
        "Namespace": String,
        "OKActions": [Value, Value, ...],
        "Period": String,
        "Statistic": String,
        "Threshold": String,
        "Units": String
      }
    }
  }
}

OS::Heat::HARestarter

Properties

InstanceId : String

Instance ID to be restarted.

Required property.

Attributes

AlarmUrl
A signed url to handle the alarm (Heat extension).

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Heat::HARestarter
    properties:
      InstanceId: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Heat::HARestarter
    Properties:
      InstanceId: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Heat::HARestarter",
      "Properties": {
        "InstanceId": String
      }
    }
  }
}

OS::Heat::InstanceGroup

Properties

AvailabilityZones : List

Not Implemented.

Required property.

LaunchConfigurationName : String

Name of LaunchConfiguration resource.

Required property.

LoadBalancerNames : List

List of LoadBalancer resources.

Optional property.

Size : Number

Desired number of instances.

Required property.

Tags : List

Tags to attach to this group.

Optional property.

List contents:
* : Map

Optional property.

Map properties:
Key : String
Required property.
Value : String
Required property.

Attributes

InstanceList
A comma-delimited list of server ip addresses. (Heat extension).

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Heat::InstanceGroup
    properties:
      AvailabilityZones: [Value, Value, ...]
      LaunchConfigurationName: String
      LoadBalancerNames: [Value, Value, ...]
      Size: Number
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Heat::InstanceGroup
    Properties:
      AvailabilityZones: [Value, Value, ...]
      LaunchConfigurationName: String
      LoadBalancerNames: [Value, Value, ...]
      Size: Number
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Heat::InstanceGroup",
      "Properties": {
        "AvailabilityZones": [Value, Value, ...],
        "LaunchConfigurationName": String,
        "LoadBalancerNames": [Value, Value, ...],
        "Size": Number,
        "Tags": [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      }
    }
  }
}

OS::Neutron::Firewall

A resource for the Firewall resource in Neutron FWaaS.

Properties

admin_state_up : Boolean
Optional property, defaults to “True”.
description : String
Optional property.
firewall_policy_id : String
Required property.
name : String
Optional property.

Attributes

admin_state_up
The administrative state of the Firewall.
description
Description of the Firewall.
firewall_policy_id
Unique identifier of the FirewallPolicy used to create the Firewall.
name
Name for the Firewall.
show
All attributes.
status
The status of the Firewall.
tenant_id
Id of the tenant owning the Firewall.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Firewall
    properties:
      admin_state_up: Boolean
      description: String
      firewall_policy_id: String
      name: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Firewall
    Properties:
      admin_state_up: Boolean
      description: String
      firewall_policy_id: String
      name: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Firewall",
      "Properties": {
        "admin_state_up": Boolean,
        "description": String,
        "firewall_policy_id": String,
        "name": String
      }
    }
  }
}

OS::Neutron::FirewallPolicy

A resource for the FirewallPolicy resource in Neutron FWaaS.

Properties

audited : Boolean
Optional property, defaults to “False”.
description : String
Optional property.
firewall_rules : List
Required property.
name : String
Optional property.
shared : Boolean
Optional property, defaults to “False”.

Attributes

audited
Audit status of this FirewallPolicy.
description
Description of the FirewallPolicy.
firewall_rules
List of FirewallRules in this FirewallPolicy.
name
Name for the FirewallPolicy.
shared
Shared status of this FirewallPolicy.
tenant_id
Id of the tenant owning the FirewallPolicy.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FirewallPolicy
    properties:
      audited: Boolean
      description: String
      firewall_rules: [Value, Value, ...]
      name: String
      shared: Boolean

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::FirewallPolicy
    Properties:
      audited: Boolean
      description: String
      firewall_rules: [Value, Value, ...]
      name: String
      shared: Boolean

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::FirewallPolicy",
      "Properties": {
        "audited": Boolean,
        "description": String,
        "firewall_rules": [Value, Value, ...],
        "name": String,
        "shared": Boolean
      }
    }
  }
}

OS::Neutron::FirewallRule

A resource for the FirewallRule resource in Neutron FWaaS.

Properties

action : String

Optional property, defaults to “deny”.

Allowed values: allow, deny

description : String
Optional property.
destination_ip_address : String
Optional property.
destination_port : String
Optional property.
enabled : Boolean
Optional property, defaults to “True”.
ip_version : String

Optional property, defaults to “4”.

Allowed values: 4, 6

name : String
Optional property.
protocol : String

Optional property.

Allowed values: tcp, udp, icmp, None

shared : Boolean
Optional property, defaults to “False”.
source_ip_address : String
Optional property.
source_port : String
Optional property.

Attributes

action
Allow or deny action for this FirewallRule.
description
Description of the FirewallRule.
destination_ip_address
Destination ip_address for this FirewallRule.
destination_port
Destination port range for this FirewallRule.
enabled
Indicates whether this FirewallRule is enabled or not.
firewall_policy_id
Unique identifier of the FirewallPolicy to which this FirewallRule belongs.
ip_version
Ip_version for this FirewallRule.
name
Name for the FirewallRule.
position
Position of the rule within the FirewallPolicy.
protocol
Protocol value for this FirewallRule.
shared
Shared status of this FirewallRule.
source_ip_address
Source ip_address for this FirewallRule.
source_port
Source port range for this FirewallRule.
tenant_id
Id of the tenant owning the Firewall.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FirewallRule
    properties:
      action: String
      description: String
      destination_ip_address: String
      destination_port: String
      enabled: Boolean
      ip_version: String
      name: String
      protocol: String
      shared: Boolean
      source_ip_address: String
      source_port: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::FirewallRule
    Properties:
      action: String
      description: String
      destination_ip_address: String
      destination_port: String
      enabled: Boolean
      ip_version: String
      name: String
      protocol: String
      shared: Boolean
      source_ip_address: String
      source_port: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::FirewallRule",
      "Properties": {
        "action": String,
        "description": String,
        "destination_ip_address": String,
        "destination_port": String,
        "enabled": Boolean,
        "ip_version": String,
        "name": String,
        "protocol": String,
        "shared": Boolean,
        "source_ip_address": String,
        "source_port": String
      }
    }
  }
}

OS::Neutron::FloatingIP

Properties

fixed_ip_address : String

IP address to use if the port has multiple addresses.

Optional property.

floating_network_id : String

ID of network to allocate floating IP from.

Required property.

port_id : String

ID of an existing port with at least one IP address to associate with this floating IP.

Optional property.

value_specs : Map

Extra parameters to include in the “floatingip” object in the creation request. Parameters are often specific to installed hardware or extensions.

Optional property, defaults to “{}”.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FloatingIP
    properties:
      fixed_ip_address: String
      floating_network_id: String
      port_id: String
      value_specs: {...}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::FloatingIP
    Properties:
      fixed_ip_address: String
      floating_network_id: String
      port_id: String
      value_specs: {...}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::FloatingIP",
      "Properties": {
        "fixed_ip_address": String,
        "floating_network_id": String,
        "port_id": String,
        "value_specs": {...}
      }
    }
  }
}

OS::Neutron::FloatingIPAssociation

Properties

fixed_ip_address : String

IP address to use if the port has multiple addresses.

Optional property.

floatingip_id : String

ID of the floating IP to associate.

Required property.

port_id : String

ID of an existing port with at least one IP address to associate with this floating IP.

Optional property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FloatingIPAssociation
    properties:
      fixed_ip_address: String
      floatingip_id: String
      port_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::FloatingIPAssociation
    Properties:
      fixed_ip_address: String
      floatingip_id: String
      port_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::FloatingIPAssociation",
      "Properties": {
        "fixed_ip_address": String,
        "floatingip_id": String,
        "port_id": String
      }
    }
  }
}

OS::Neutron::HealthMonitor

A resource for managing health monitors for load balancers in Neutron.

Properties

admin_state_up : Boolean

The administrative state of the health monitor.

Optional property, defaults to “True”.

delay : Integer

The minimum time in seconds between regular connections of the member.

Required property.

expected_codes : String

The list of HTTP status codes expected in response from the member to declare it healthy.

Optional property.

http_method : String

The HTTP method used for requests by the monitor of type HTTP.

Optional property.

max_retries : Integer

Number of permissible connection failures before changing the member status to INACTIVE.

Required property.

timeout : Integer

Maximum number of seconds for a monitor to wait for a connection to be established before it times out.

Required property.

type : String

One of predefined health monitor types.

Required property.

Allowed values: PING, TCP, HTTP, HTTPS

url_path : String

The HTTP path used in the HTTP request used by the monitor to test a member health.

Optional property.

Attributes

admin_state_up
The administrative state of this health monitor.
delay
The minimum time in seconds between regular connections of the member.
expected_codes
The list of HTTP status codes expected in response from the member to declare it healthy.
http_method
The HTTP method used for requests by the monitor of type HTTP.
max_retries
Number of permissible connection failures before changing the member status to INACTIVE.
show
All attributes.
tenant_id
Tenant owning the health monitor.
timeout
Maximum number of seconds for a monitor to wait for a connection to be established before it times out.
type
One of predefined health monitor types.
url_path
The HTTP path used in the HTTP request used by the monitor to test a member health.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::HealthMonitor
    properties:
      admin_state_up: Boolean
      delay: Integer
      expected_codes: String
      http_method: String
      max_retries: Integer
      timeout: Integer
      type: String
      url_path: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::HealthMonitor
    Properties:
      admin_state_up: Boolean
      delay: Integer
      expected_codes: String
      http_method: String
      max_retries: Integer
      timeout: Integer
      type: String
      url_path: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::HealthMonitor",
      "Properties": {
        "admin_state_up": Boolean,
        "delay": Integer,
        "expected_codes": String,
        "http_method": String,
        "max_retries": Integer,
        "timeout": Integer,
        "type": String,
        "url_path": String
      }
    }
  }
}

OS::Neutron::IKEPolicy

A resource for IKE policy in Neutron.

Properties

auth_algorithm : String

Authentication hash algorithm for the ike policy.

Optional property, defaults to “sha1”.

Allowed values: sha1

description : String

Description for the ike policy.

Optional property.

encryption_algorithm : String

Encryption algorithm for the ike policy.

Optional property, defaults to “aes-128”.

Allowed values: 3des, aes-128, aes-192, aes-256

ike_version : String

Version for the ike policy.

Optional property, defaults to “v1”.

Allowed values: v1, v2

lifetime : Map

Safety assessment lifetime configuration for the ike policy.

Optional property.

Map properties:
units : String

Safety assessment lifetime units.

Optional property, defaults to “seconds”.

Allowed values: seconds, kilobytes

value : Integer

Safety assessment lifetime value in specified units.

Optional property, defaults to “3600”.

name : String

Name for the ike policy.

Optional property.

pfs : String

Perfect forward secrecy in lowercase for the ike policy.

Optional property, defaults to “group5”.

Allowed values: group2, group5, group14

phase1_negotiation_mode : String

Negotiation mode for the ike policy.

Optional property, defaults to “main”.

Allowed values: main

Attributes

auth_algorithm
The authentication hash algorithm used by the ike policy.
description
The description of the ike policy.
encryption_algorithm
The encryption algorithm used by the ike policy.
ike_version
The version of the ike policy.
lifetime
The safety assessment lifetime configuration for the ike policy.
name
The name of the ike policy.
pfs
The perfect forward secrecy of the ike policy.
phase1_negotiation_mode
The negotiation mode of the ike policy.
tenant_id
The unique identifier of the tenant owning the ike policy.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::IKEPolicy
    properties:
      auth_algorithm: String
      description: String
      encryption_algorithm: String
      ike_version: String
      lifetime: {"units": String, "value": Integer}
      name: String
      pfs: String
      phase1_negotiation_mode: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::IKEPolicy
    Properties:
      auth_algorithm: String
      description: String
      encryption_algorithm: String
      ike_version: String
      lifetime: {"units": String, "value": Integer}
      name: String
      pfs: String
      phase1_negotiation_mode: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::IKEPolicy",
      "Properties": {
        "auth_algorithm": String,
        "description": String,
        "encryption_algorithm": String,
        "ike_version": String,
        "lifetime": {"units": String, "value": Integer},
        "name": String,
        "pfs": String,
        "phase1_negotiation_mode": String
      }
    }
  }
}

OS::Neutron::IPsecPolicy

A resource for IPsec policy in Neutron.

Properties

auth_algorithm : String

Authentication hash algorithm for the ipsec policy.

Optional property, defaults to “sha1”.

Allowed values: sha1

description : String

Description for the ipsec policy.

Optional property.

encapsulation_mode : String

Encapsulation mode for the ipsec policy.

Optional property, defaults to “tunnel”.

Allowed values: tunnel, transport

encryption_algorithm : String

Encryption algorithm for the ipsec policy.

Optional property, defaults to “aes-128”.

Allowed values: 3des, aes-128, aes-192, aes-256

lifetime : Map

Safety assessment lifetime configuration for the ipsec policy.

Optional property.

Map properties:
units : String

Safety assessment lifetime units.

Optional property, defaults to “seconds”.

Allowed values: seconds, kilobytes

value : Integer

Safety assessment lifetime value in specified units.

Optional property, defaults to “3600”.

name : String

Name for the ipsec policy.

Optional property.

pfs : String

Perfect forward secrecy for the ipsec policy.

Optional property, defaults to “group5”.

Allowed values: group2, group5, group14

transform_protocol : String

Transform protocol for the ipsec policy.

Optional property, defaults to “esp”.

Allowed values: esp, ah, ah-esp

Attributes

auth_algorithm
The authentication hash algorithm of the ipsec policy.
description
The description of the ipsec policy.
encapsulation_mode
The encapsulation mode of the ipsec policy.
encryption_algorithm
The encryption algorithm of the ipsec policy.
lifetime
The safety assessment lifetime configuration of the ipsec policy.
name
The name of the ipsec policy.
pfs
The perfect forward secrecy of the ipsec policy.
tenant_id
The unique identifier of the tenant owning the ipsec policy.
transform_protocol
The transform protocol of the ipsec policy.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::IPsecPolicy
    properties:
      auth_algorithm: String
      description: String
      encapsulation_mode: String
      encryption_algorithm: String
      lifetime: {"units": String, "value": Integer}
      name: String
      pfs: String
      transform_protocol: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::IPsecPolicy
    Properties:
      auth_algorithm: String
      description: String
      encapsulation_mode: String
      encryption_algorithm: String
      lifetime: {"units": String, "value": Integer}
      name: String
      pfs: String
      transform_protocol: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::IPsecPolicy",
      "Properties": {
        "auth_algorithm": String,
        "description": String,
        "encapsulation_mode": String,
        "encryption_algorithm": String,
        "lifetime": {"units": String, "value": Integer},
        "name": String,
        "pfs": String,
        "transform_protocol": String
      }
    }
  }
}

OS::Neutron::IPsecSiteConnection

A resource for IPsec site connection in Neutron.

Properties

admin_state_up : Boolean

Administrative state for the ipsec site connection.

Optional property, defaults to “True”.

description : String

Description for the ipsec site connection.

Optional property.

dpd : Map

Dead Peer Detection protocol configuration for the ipsec site connection.

Optional property.

Map properties:
actions : String

Controls DPD protocol mode.

Optional property, defaults to “hold”.

Allowed values: clear, disabled, hold, restart, restart-by-peer

interval : Integer

Number of seconds for the DPD delay.

Optional property, defaults to “30”.

timeout : Integer

Number of seconds for the DPD timeout.

Optional property, defaults to “120”.

ikepolicy_id : String

Unique identifier for the ike policy associated with the ipsec site connection.

Required property.

initiator : String

Initiator state in lowercase for the ipsec site connection.

Optional property, defaults to “bi-directional”.

Allowed values: bi-directional, response-only

ipsecpolicy_id : String

Unique identifier for the ipsec policy associated with the ipsec site connection.

Required property.

mtu : Integer

Maximum transmission unit size (in bytes) for the ipsec site connection.

Optional property, defaults to “1500”.

name : String

Name for the ipsec site connection.

Optional property.

peer_address : String

Remote branch router public IPv4 address or IPv6 address or FQDN.

Required property.

peer_cidrs : List

Remote subnet(s) in CIDR format.

Required property.

peer_id : String

Remote branch router identity.

Required property.

psk : String

Pre-shared key string for the ipsec site connection.

Required property.

vpnservice_id : String

Unique identifier for the vpn service associated with the ipsec site connection.

Required property.

Attributes

admin_state_up
The administrative state of the ipsec site connection.
auth_mode
The authentication mode of the ipsec site connection.
description
The description of the ipsec site connection.
dpd
The dead peer detection protocol configuration of the ipsec site connection.
ikepolicy_id
The unique identifier of ike policy associated with the ipsec site connection.
initiator
The initiator of the ipsec site connection.
ipsecpolicy_id
The unique identifier of ipsec policy associated with the ipsec site connection.
mtu
The maximum transmission unit size (in bytes) of the ipsec site connection.
name
The name of the ipsec site connection.
peer_address
The remote branch router public IPv4 address or IPv6 address or FQDN.
peer_cidrs
The remote subnet(s) in CIDR format of the ipsec site connection.
peer_id
The remote branch router identity of the ipsec site connection.
psk
The pre-shared key string of the ipsec site connection.
route_mode
The route mode of the ipsec site connection.
status
The status of the ipsec site connection.
tenant_id
The unique identifier of the tenant owning the ipsec site connection.
vpnservice_id
The unique identifier of vpn service associated with the ipsec site connection.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::IPsecSiteConnection
    properties:
      admin_state_up: Boolean
      description: String
      dpd: {"interval": Integer, "actions": String, "timeout": Integer}
      ikepolicy_id: String
      initiator: String
      ipsecpolicy_id: String
      mtu: Integer
      name: String
      peer_address: String
      peer_cidrs: [Value, Value, ...]
      peer_id: String
      psk: String
      vpnservice_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::IPsecSiteConnection
    Properties:
      admin_state_up: Boolean
      description: String
      dpd: {"interval": Integer, "actions": String, "timeout": Integer}
      ikepolicy_id: String
      initiator: String
      ipsecpolicy_id: String
      mtu: Integer
      name: String
      peer_address: String
      peer_cidrs: [Value, Value, ...]
      peer_id: String
      psk: String
      vpnservice_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::IPsecSiteConnection",
      "Properties": {
        "admin_state_up": Boolean,
        "description": String,
        "dpd": {"interval": Integer, "actions": String, "timeout": Integer},
        "ikepolicy_id": String,
        "initiator": String,
        "ipsecpolicy_id": String,
        "mtu": Integer,
        "name": String,
        "peer_address": String,
        "peer_cidrs": [Value, Value, ...],
        "peer_id": String,
        "psk": String,
        "vpnservice_id": String
      }
    }
  }
}

OS::Neutron::LoadBalancer

A resource to link a neutron pool with servers.

Properties

members : List

The list of Nova server IDs load balanced.

Optional property.

pool_id : String

The ID of the load balancing pool.

Required property.

protocol_port : Integer

Port number on which the servers are running on the members.

Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LoadBalancer
    properties:
      members: [Value, Value, ...]
      pool_id: String
      protocol_port: Integer

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::LoadBalancer
    Properties:
      members: [Value, Value, ...]
      pool_id: String
      protocol_port: Integer

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::LoadBalancer",
      "Properties": {
        "members": [Value, Value, ...],
        "pool_id": String,
        "protocol_port": Integer
      }
    }
  }
}

OS::Neutron::Net

Properties

admin_state_up : Boolean

A boolean value specifying the administrative status of the network.

Optional property, defaults to “True”.

name : String

A string specifying a symbolic name for the network, which is not required to be unique.

Optional property.

shared : Boolean

Whether this network should be shared across all tenants. Note that the default policy setting restricts usage of this attribute to administrative users only.

Optional property.

tenant_id : String

The ID of the tenant which will own the network. Only administrative users can set the tenant identifier; this cannot be changed using authorization policies.

Optional property.

value_specs : Map

Extra parameters to include in the “network” object in the creation request. Parameters are often specific to installed hardware or extensions.

Optional property, defaults to “{}”.

Attributes

admin_state_up
The administrative status of the network.
name
The name of the network.
show
All attributes.
status
The status of the network.
subnets
Subnets of this network.
tenant_id
The tenant owning this network.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Net
    properties:
      admin_state_up: Boolean
      name: String
      shared: Boolean
      tenant_id: String
      value_specs: {...}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Net
    Properties:
      admin_state_up: Boolean
      name: String
      shared: Boolean
      tenant_id: String
      value_specs: {...}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Net",
      "Properties": {
        "admin_state_up": Boolean,
        "name": String,
        "shared": Boolean,
        "tenant_id": String,
        "value_specs": {...}
      }
    }
  }
}

OS::Neutron::Pool

A resource for managing load balancer pools in Neutron.

Properties

admin_state_up : Boolean

The administrative state of this pool.

Optional property, defaults to “True”.

description : String

Description of the pool.

Optional property.

lb_method : String

The algorithm used to distribute load between the members of the pool.

Required property.

Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP

monitors : List

List of health monitors associated with the pool.

Optional property.

name : String

Name of the pool.

Optional property.

protocol : String

Protocol for balancing.

Required property.

Allowed values: TCP, HTTP, HTTPS

subnet_id : String

The subnet on which the members of the pool will be located.

Required property.

vip : Map

IP address and port of the pool.

Required property.

Map properties:
address : String

IP address of the vip.

Optional property.

admin_state_up : Boolean

The administrative state of this vip.

Optional property, defaults to “True”.

connection_limit : Integer

The maximum number of connections per second allowed for the vip.

Optional property.

description : String

Description of the vip.

Optional property.

name : String

Name of the vip.

Optional property.

protocol_port : Integer

TCP port on which to listen for client traffic that is associated with the vip address.

Required property.

Attributes

admin_state_up
The administrative state of this pool.
description
Description of the pool.
lb_method
The algorithm used to distribute load between the members of the pool.
name
Name of the pool.
protocol
Protocol to balance.
subnet_id
The subnet on which the members of the pool will be located.
tenant_id
Tenant owning the pool.
vip
Vip associated with the pool.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Pool
    properties:
      admin_state_up: Boolean
      description: String
      lb_method: String
      monitors: [Value, Value, ...]
      name: String
      protocol: String
      subnet_id: String
      vip: {"description": String, "admin_state_up": Boolean, "connection_limit": Integer, "address": String, "protocol_port": Integer, "name": String}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Pool
    Properties:
      admin_state_up: Boolean
      description: String
      lb_method: String
      monitors: [Value, Value, ...]
      name: String
      protocol: String
      subnet_id: String
      vip: {"description": String, "admin_state_up": Boolean, "connection_limit": Integer, "address": String, "protocol_port": Integer, "name": String}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Pool",
      "Properties": {
        "admin_state_up": Boolean,
        "description": String,
        "lb_method": String,
        "monitors": [Value, Value, ...],
        "name": String,
        "protocol": String,
        "subnet_id": String,
        "vip": {"description": String, "admin_state_up": Boolean, "connection_limit": Integer, "address": String, "protocol_port": Integer, "name": String}
      }
    }
  }
}

OS::Neutron::Port

Properties

admin_state_up : Boolean
Optional property, defaults to “True”.
device_id : String
Optional property.
fixed_ips : List

Optional property.

List contents:
* : Map

Optional property.

Map properties:
ip_address : String
Optional property.
subnet_id : String
Optional property.
mac_address : String
Optional property.
name : String
Optional property.
network_id : String
Required property.
security_groups : List
Optional property.
value_specs : Map
Optional property, defaults to “{}”.

Attributes

admin_state_up
The administrative state of this port.
device_id
Unique identifier for the device.
device_owner
Name of the network owning the port.
fixed_ips
Fixed ip addresses.
mac_address
Mac address of the port.
name
Friendly name of the port.
network_id
Unique identifier for the network owning the port.
security_groups
A list of security groups for the port.
show
All attributes.
status
The status of the port.
tenant_id
Tenant owning the port

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Port
    properties:
      admin_state_up: Boolean
      device_id: String
      fixed_ips: [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...]
      mac_address: String
      name: String
      network_id: String
      security_groups: [Value, Value, ...]
      value_specs: {...}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Port
    Properties:
      admin_state_up: Boolean
      device_id: String
      fixed_ips: [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...]
      mac_address: String
      name: String
      network_id: String
      security_groups: [Value, Value, ...]
      value_specs: {...}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Port",
      "Properties": {
        "admin_state_up": Boolean,
        "device_id": String,
        "fixed_ips": [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...],
        "mac_address": String,
        "name": String,
        "network_id": String,
        "security_groups": [Value, Value, ...],
        "value_specs": {...}
      }
    }
  }
}

OS::Neutron::Router

Properties

admin_state_up : Boolean
Optional property, defaults to “True”.
name : String
Optional property.
value_specs : Map
Optional property, defaults to “{}”.

Attributes

admin_state_up
Administrative state of the router.
external_gateway_info
Gateway network for the router.
name
Friendly name of the router.
show
All attributes.
status
The status of the router.
tenant_id
Tenant owning the router.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Router
    properties:
      admin_state_up: Boolean
      name: String
      value_specs: {...}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Router
    Properties:
      admin_state_up: Boolean
      name: String
      value_specs: {...}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Router",
      "Properties": {
        "admin_state_up": Boolean,
        "name": String,
        "value_specs": {...}
      }
    }
  }
}

OS::Neutron::RouterGateway

Properties

network_id : String
Required property.
router_id : String
Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::RouterGateway
    properties:
      network_id: String
      router_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::RouterGateway
    Properties:
      network_id: String
      router_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::RouterGateway",
      "Properties": {
        "network_id": String,
        "router_id": String
      }
    }
  }
}

OS::Neutron::RouterInterface

Properties

router_id : String
Required property.
subnet_id : String
Required property.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::RouterInterface
    properties:
      router_id: String
      subnet_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::RouterInterface
    Properties:
      router_id: String
      subnet_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::RouterInterface",
      "Properties": {
        "router_id": String,
        "subnet_id": String
      }
    }
  }
}

OS::Neutron::Subnet

Properties

allocation_pools : List

Optional property.

List contents:
* : Map

Optional property.

Map properties:
end : String
Required property.
start : String
Required property.
cidr : String
Required property.
dns_nameservers : List
Optional property.
enable_dhcp : Boolean
Optional property.
gateway_ip : String
Optional property.
ip_version : Integer

Optional property, defaults to “4”.

Allowed values: 4, 6

name : String
Optional property.
network_id : String
Required property.
tenant_id : String
Optional property.
value_specs : Map
Optional property, defaults to “{}”.

Attributes

allocation_pools
Ip allocation pools and their ranges.
cidr
CIDR block notation for this subnet.
dns_nameservers
List of dns nameservers.
enable_dhcp
‘true’ if DHCP is enabled for this subnet; ‘false’ otherwise.
gateway_ip
Ip of the subnet’s gateway.
ip_version
Ip version for the subnet.
name
Friendly name of the subnet.
network_id
Parent network of the subnet.
show
All attributes.
tenant_id
Tenant owning the subnet.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Subnet
    properties:
      allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
      cidr: String
      dns_nameservers: [Value, Value, ...]
      enable_dhcp: Boolean
      gateway_ip: String
      ip_version: Integer
      name: String
      network_id: String
      tenant_id: String
      value_specs: {...}

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::Subnet
    Properties:
      allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
      cidr: String
      dns_nameservers: [Value, Value, ...]
      enable_dhcp: Boolean
      gateway_ip: String
      ip_version: Integer
      name: String
      network_id: String
      tenant_id: String
      value_specs: {...}

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::Subnet",
      "Properties": {
        "allocation_pools": [{"start": String, "end": String}, {"start": String, "end": String}, ...],
        "cidr": String,
        "dns_nameservers": [Value, Value, ...],
        "enable_dhcp": Boolean,
        "gateway_ip": String,
        "ip_version": Integer,
        "name": String,
        "network_id": String,
        "tenant_id": String,
        "value_specs": {...}
      }
    }
  }
}

OS::Neutron::VPNService

A resource for VPN service in Neutron.

Properties

admin_state_up : Boolean

Administrative state for the vpn service.

Optional property, defaults to “True”.

description : String

Description for the vpn service.

Optional property.

name : String

Name for the vpn service.

Optional property.

router_id : String

Unique identifier for the router to which the vpn service will be inserted.

Required property.

subnet_id : String

Unique identifier for the subnet in which the vpn service will be created.

Required property.

Attributes

admin_state_up
The administrative state of the vpn service.
description
The description of the vpn service.
name
The name of the vpn service.
router_id
The unique identifier of the router to which the vpn service was inserted.
show
All attributes.
status
The status of the vpn service.
subnet_id
The unique identifier of the subnet in which the vpn service was created.
tenant_id
The unique identifier of the tenant owning the vpn service.

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Neutron::VPNService
    properties:
      admin_state_up: Boolean
      description: String
      name: String
      router_id: String
      subnet_id: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Neutron::VPNService
    Properties:
      admin_state_up: Boolean
      description: String
      name: String
      router_id: String
      subnet_id: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Neutron::VPNService",
      "Properties": {
        "admin_state_up": Boolean,
        "description": String,
        "name": String,
        "router_id": String,
        "subnet_id": String
      }
    }
  }
}

OS::Nova::Server

Properties

availability_zone : String

Name of the availability zone for server placement

Optional property.

block_device_mapping : List

Block device mappings for this server

Optional property.

List contents:
* : Map

Optional property.

Map properties:
delete_on_termination : Boolean

Indicate whether the volume should be deleted when the server is terminated

Optional property.

device_name : String

A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda

Required property.

snapshot_id : String

The ID of the snapshot to create a volume from

Optional property.

volume_id : String

The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided

Optional property.

volume_size : String

The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size

Optional property.

config_drive : String

value for config drive either boolean, or volume-id

Optional property.

diskConfig : String

Control how the disk is partitioned when the server is created

Optional property.

Allowed values: AUTO, MANUAL

flavor : String

The ID or name of the flavor to boot onto

Required property.

flavor_update_policy : String

Policy on how to apply a flavor update; either by requesting a server resize or by replacing the entire server

Optional property, defaults to “RESIZE”.

Allowed values: RESIZE, REPLACE

image : String

The ID or name of the image to boot with

Optional property.

key_name : String

Name of keypair to inject into the server

Optional property.

metadata : Map

Arbitrary key/value metadata to store for this server. A maximum of five entries is allowed, and both keys and values must be 255 characters or less

Optional property.

name : String

Optional server name

Optional property.

networks : List

An ordered list of nics to be added to this server, with information about connected networks, fixed ips, port etc

Optional property.

List contents:
* : Map

Optional property.

Map properties:
fixed_ip : String

Fixed IP address to specify for the port created on the requested network

Optional property.

port : String

ID of an existing port to associate with this server

Optional property.

uuid : String

ID of network to create a port on

Optional property.

reservation_id : String

A UUID for the set of servers being requested

Optional property.

scheduler_hints : Map

Arbitrary key-value pairs specified by the client to help boot a server

Optional property.

security_groups : List

List of security group names

Optional property.

user_data : String

User data script to be executed by cloud-init

Optional property.

Attributes

accessIPv4
The manually assigned alternative public IPv4 address of the server
accessIPv6
The manually assigned alternative public IPv6 address of the server
addresses
A dict of all network addresses as returned by the API
first_address
Convenience attribute to fetch the first assigned network address, or an empty string if nothing has been assigned at this time. Result may not be predictable if the server has addresses from more than one network.
instance_name
AWS compatible instance name
networks
A dict of assigned network addresses of the form: {“public”: [ip1, ip2...], “private”: [ip3, ip4]}
show
A dict of all server details as returned by the API

HOT Syntax

heat_template_version: 2013-05-23
...
resources:
  ...
  the_resource:
    type: OS::Nova::Server
    properties:
      availability_zone: String
      block_device_mapping: [{"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, {"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, ...]
      config_drive: String
      diskConfig: String
      flavor: String
      flavor_update_policy: String
      image: String
      key_name: String
      metadata: {...}
      name: String
      networks: [{"fixed_ip": String, "uuid": String, "port": String}, {"fixed_ip": String, "uuid": String, "port": String}, ...]
      reservation_id: String
      scheduler_hints: {...}
      security_groups: [Value, Value, ...]
      user_data: String

YAML Syntax

HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
  ...
  TheResource:
    Type: OS::Nova::Server
    Properties:
      availability_zone: String
      block_device_mapping: [{"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, {"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, ...]
      config_drive: String
      diskConfig: String
      flavor: String
      flavor_update_policy: String
      image: String
      key_name: String
      metadata: {...}
      name: String
      networks: [{"fixed_ip": String, "uuid": String, "port": String}, {"fixed_ip": String, "uuid": String, "port": String}, ...]
      reservation_id: String
      scheduler_hints: {...}
      security_groups: [Value, Value, ...]
      user_data: String

JSON Syntax

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  ...
  "Resources" : {
    "TheResource": {
      "Type": "OS::Nova::Server",
      "Properties": {
        "availability_zone": String,
        "block_device_mapping": [{"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, {"device_name": String, "volume_size": String, "snapshot_id": String, "delete_on_termination": Boolean, "volume_id": String}, ...],
        "config_drive": String,
        "diskConfig": String,
        "flavor": String,
        "flavor_update_policy": String,
        "image": String,
        "key_name": String,
        "metadata": {...},
        "name": String,
        "networks": [{"fixed_ip": String, "uuid": String, "port": String}, {"fixed_ip": String, "uuid": String, "port": String}, ...],
        "reservation_id": String,
        "scheduler_hints": {...},
        "security_groups": [Value, Value, ...],
        "user_data": String
      }
    }
  }
}

Table Of Contents

Previous topic

Built in functions

Next topic

CloudFormation Compatible Resource Types

This Page