A list of URLs (webhooks) to invoke when state transitions to alarm
Optional property.
Operator used to compare specified statistic with threshold
Required property.
Allowed values: ge, gt, eq, ne, lt, le
Description for the alarm
Optional property.
True if alarm evaluation/actioning is enabled
Optional property, defaults to “true”.
Number of periods to evaluate over
Required property.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data
Optional property.
Meter should match this resource metadata (key=value) additionally to the meter_name
Optional property.
Meter name watched by the alarm
Required property.
A list of URLs (webhooks) to invoke when state transitions to ok
Optional property.
Period (seconds) to evaluate over
Required property.
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”.
Meter statistic to evaluate
Required property.
Allowed values: count, avg, sum, min, max
Threshold to evaluate against
Required property.
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
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
{
"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
}
}
}
}
The availability zone in which the volume will be created.
Optional property.
If specified, the backup to create the volume from.
Optional property.
A description of the volume.
Optional property.
If specified, the name or ID of the image to create the volume from.
Optional property.
DEPRECATED: use “image” instead.
Optional property.
Key/value pairs to associate with the volume.
Optional property.
A name used to distinguish the volume.
Optional property.
The size of the volume in GB.
Optional property.
If specified, the snapshot to create the volume from.
Optional property.
If specified, the volume to use as source.
Optional property.
If specified, the type of volume to use, mapping to a specific backend.
Optional property.
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
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
{
"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
}
}
}
}
The ID of the server to which the volume attaches.
Required property.
The location where the volume is exposed on the instance.
Required property.
The ID of the volume to be attached.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Cinder::VolumeAttachment
properties:
instance_uuid: String
mountpoint: String
volume_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Cinder::VolumeAttachment
Properties:
instance_uuid: String
mountpoint: String
volume_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Cinder::VolumeAttachment",
"Properties": {
"instance_uuid": String,
"mountpoint": String,
"volume_id": String
}
}
}
}
Resources that users are allowed to access by the DescribeStackResource API.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::AccessPolicy
properties:
AllowedResources: [Value, Value, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::AccessPolicy
Properties:
AllowedResources: [Value, Value, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::AccessPolicy",
"Properties": {
"AllowedResources": [Value, Value, ...]
}
}
}
}
A list of actions to execute when state transitions to alarm.
Optional property.
Description for the alarm.
Optional property.
Operator used to compare the specified Statistic with Threshold.
Optional property.
Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
A list of dimensions (arbitrary name/value pairs) associated with the metric.
Optional property.
Number of periods to evaluate over.
Optional property.
A list of actions to execute when state transitions to insufficient-data.
Optional property.
Metric name watched by the alarm.
Optional property.
Namespace for the metric.
Optional property.
A list of actions to execute when state transitions to ok.
Optional property.
Period (seconds) to evaluate over.
Optional property.
Metric statistic to evaluate.
Optional property.
Allowed values: SampleCount, Average, Sum, Minimum, Maximum
Threshold to evaluate against.
Optional property.
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
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
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
{
"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
}
}
}
}
Instance ID to be restarted.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::HARestarter
properties:
InstanceId: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::HARestarter
Properties:
InstanceId: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::HARestarter",
"Properties": {
"InstanceId": String
}
}
}
}
Not Implemented.
Required property.
Name of LaunchConfiguration resource.
Required property.
List of LoadBalancer resources.
Optional property.
Desired number of instances.
Required property.
Tags to attach to this group.
Optional property.
List contents:Optional property.
Map properties:
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}, ...]
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}, ...]
{
"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}, ...]
}
}
}
}
A resource for the Firewall resource in Neutron FWaaS.
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
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Firewall
Properties:
admin_state_up: Boolean
description: String
firewall_policy_id: String
name: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Firewall",
"Properties": {
"admin_state_up": Boolean,
"description": String,
"firewall_policy_id": String,
"name": String
}
}
}
}
A resource for the FirewallPolicy resource in Neutron FWaaS.
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
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FirewallPolicy
Properties:
audited: Boolean
description: String
firewall_rules: [Value, Value, ...]
name: String
shared: Boolean
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FirewallPolicy",
"Properties": {
"audited": Boolean,
"description": String,
"firewall_rules": [Value, Value, ...],
"name": String,
"shared": Boolean
}
}
}
}
A resource for the FirewallRule resource in Neutron FWaaS.
Optional property, defaults to “deny”.
Allowed values: allow, deny
Optional property, defaults to “4”.
Allowed values: 4, 6
Optional property.
Allowed values: tcp, udp, icmp, None
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
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
{
"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
}
}
}
}
IP address to use if the port has multiple addresses.
Optional property.
ID of network to allocate floating IP from.
Required property.
ID of an existing port with at least one IP address to associate with this floating IP.
Optional property.
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 “{}”.
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: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FloatingIP
Properties:
fixed_ip_address: String
floating_network_id: String
port_id: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FloatingIP",
"Properties": {
"fixed_ip_address": String,
"floating_network_id": String,
"port_id": String,
"value_specs": {...}
}
}
}
}
IP address to use if the port has multiple addresses.
Optional property.
ID of the floating IP to associate.
Required property.
ID of an existing port with at least one IP address to associate with this floating IP.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIPAssociation
properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FloatingIPAssociation
Properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FloatingIPAssociation",
"Properties": {
"fixed_ip_address": String,
"floatingip_id": String,
"port_id": String
}
}
}
}
A resource for managing health monitors for load balancers in Neutron.
The administrative state of the health monitor.
Optional property, defaults to “True”.
The minimum time in seconds between regular connections of the member.
Required property.
The list of HTTP status codes expected in response from the member to declare it healthy.
Optional property.
The HTTP method used for requests by the monitor of type HTTP.
Optional property.
Number of permissible connection failures before changing the member status to INACTIVE.
Required property.
Maximum number of seconds for a monitor to wait for a connection to be established before it times out.
Required property.
One of predefined health monitor types.
Required property.
Allowed values: PING, TCP, HTTP, HTTPS
The HTTP path used in the HTTP request used by the monitor to test a member health.
Optional property.
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
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
{
"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
}
}
}
}
A resource for IKE policy in Neutron.
Authentication hash algorithm for the ike policy.
Optional property, defaults to “sha1”.
Allowed values: sha1
Description for the ike policy.
Optional property.
Encryption algorithm for the ike policy.
Optional property, defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Version for the ike policy.
Optional property, defaults to “v1”.
Allowed values: v1, v2
Safety assessment lifetime configuration for the ike policy.
Optional property.
Map properties:Safety assessment lifetime units.
Optional property, defaults to “seconds”.
Allowed values: seconds, kilobytes
Safety assessment lifetime value in specified units.
Optional property, defaults to “3600”.
Name for the ike policy.
Optional property.
Perfect forward secrecy in lowercase for the ike policy.
Optional property, defaults to “group5”.
Allowed values: group2, group5, group14
Negotiation mode for the ike policy.
Optional property, defaults to “main”.
Allowed values: main
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
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
{
"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
}
}
}
}
A resource for IPsec policy in Neutron.
Authentication hash algorithm for the ipsec policy.
Optional property, defaults to “sha1”.
Allowed values: sha1
Description for the ipsec policy.
Optional property.
Encapsulation mode for the ipsec policy.
Optional property, defaults to “tunnel”.
Allowed values: tunnel, transport
Encryption algorithm for the ipsec policy.
Optional property, defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Safety assessment lifetime configuration for the ipsec policy.
Optional property.
Map properties:Safety assessment lifetime units.
Optional property, defaults to “seconds”.
Allowed values: seconds, kilobytes
Safety assessment lifetime value in specified units.
Optional property, defaults to “3600”.
Name for the ipsec policy.
Optional property.
Perfect forward secrecy for the ipsec policy.
Optional property, defaults to “group5”.
Allowed values: group2, group5, group14
Transform protocol for the ipsec policy.
Optional property, defaults to “esp”.
Allowed values: esp, ah, ah-esp
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
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
{
"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
}
}
}
}
A resource for IPsec site connection in Neutron.
Administrative state for the ipsec site connection.
Optional property, defaults to “True”.
Description for the ipsec site connection.
Optional property.
Dead Peer Detection protocol configuration for the ipsec site connection.
Optional property.
Map properties:Controls DPD protocol mode.
Optional property, defaults to “hold”.
Allowed values: clear, disabled, hold, restart, restart-by-peer
Number of seconds for the DPD delay.
Optional property, defaults to “30”.
Number of seconds for the DPD timeout.
Optional property, defaults to “120”.
Unique identifier for the ike policy associated with the ipsec site connection.
Required property.
Initiator state in lowercase for the ipsec site connection.
Optional property, defaults to “bi-directional”.
Allowed values: bi-directional, response-only
Unique identifier for the ipsec policy associated with the ipsec site connection.
Required property.
Maximum transmission unit size (in bytes) for the ipsec site connection.
Optional property, defaults to “1500”.
Name for the ipsec site connection.
Optional property.
Remote branch router public IPv4 address or IPv6 address or FQDN.
Required property.
Remote subnet(s) in CIDR format.
Required property.
Remote branch router identity.
Required property.
Pre-shared key string for the ipsec site connection.
Required property.
Unique identifier for the vpn service associated with the ipsec site connection.
Required property.
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
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
{
"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
}
}
}
}
A resource to link a neutron pool with servers.
The list of Nova server IDs load balanced.
Optional property.
The ID of the load balancing pool.
Required property.
Port number on which the servers are running on the members.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::LoadBalancer
properties:
members: [Value, Value, ...]
pool_id: String
protocol_port: Integer
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::LoadBalancer
Properties:
members: [Value, Value, ...]
pool_id: String
protocol_port: Integer
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::LoadBalancer",
"Properties": {
"members": [Value, Value, ...],
"pool_id": String,
"protocol_port": Integer
}
}
}
}
A boolean value specifying the administrative status of the network.
Optional property, defaults to “True”.
A string specifying a symbolic name for the network, which is not required to be unique.
Optional property.
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.
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.
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 “{}”.
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: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Net
Properties:
admin_state_up: Boolean
name: String
shared: Boolean
tenant_id: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Net",
"Properties": {
"admin_state_up": Boolean,
"name": String,
"shared": Boolean,
"tenant_id": String,
"value_specs": {...}
}
}
}
}
A resource for managing load balancer pools in Neutron.
The administrative state of this pool.
Optional property, defaults to “True”.
Description of the pool.
Optional property.
The algorithm used to distribute load between the members of the pool.
Required property.
Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP
List of health monitors associated with the pool.
Optional property.
Name of the pool.
Optional property.
Protocol for balancing.
Required property.
Allowed values: TCP, HTTP, HTTPS
The subnet on which the members of the pool will be located.
Required property.
IP address and port of the pool.
Required property.
Map properties:IP address of the vip.
Optional property.
The administrative state of this vip.
Optional property, defaults to “True”.
The maximum number of connections per second allowed for the vip.
Optional property.
Description of the vip.
Optional property.
Name of the vip.
Optional property.
TCP port on which to listen for client traffic that is associated with the vip address.
Required property.
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}
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}
{
"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}
}
}
}
}
Optional property.
List contents:Optional property.
Map properties:
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: {...}
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: {...}
{
"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": {...}
}
}
}
}
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Router
properties:
admin_state_up: Boolean
name: String
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Router
Properties:
admin_state_up: Boolean
name: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Router",
"Properties": {
"admin_state_up": Boolean,
"name": String,
"value_specs": {...}
}
}
}
}
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::RouterGateway
properties:
network_id: String
router_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::RouterGateway
Properties:
network_id: String
router_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::RouterGateway",
"Properties": {
"network_id": String,
"router_id": String
}
}
}
}
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::RouterInterface
properties:
router_id: String
subnet_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::RouterInterface
Properties:
router_id: String
subnet_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::RouterInterface",
"Properties": {
"router_id": String,
"subnet_id": String
}
}
}
}
Optional property.
List contents:Optional property.
Map properties:Optional property, defaults to “4”.
Allowed values: 4, 6
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: {...}
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: {...}
{
"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": {...}
}
}
}
}
A resource for VPN service in Neutron.
Administrative state for the vpn service.
Optional property, defaults to “True”.
Description for the vpn service.
Optional property.
Name for the vpn service.
Optional property.
Unique identifier for the router to which the vpn service will be inserted.
Required property.
Unique identifier for the subnet in which the vpn service will be created.
Required property.
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
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
{
"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
}
}
}
}
Name of the availability zone for server placement
Optional property.
Block device mappings for this server
Optional property.
List contents:Optional property.
Map properties:Indicate whether the volume should be deleted when the server is terminated
Optional property.
A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda
Required property.
The ID of the snapshot to create a volume from
Optional property.
The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided
Optional property.
The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size
Optional property.
value for config drive either boolean, or volume-id
Optional property.
Control how the disk is partitioned when the server is created
Optional property.
Allowed values: AUTO, MANUAL
The ID or name of the flavor to boot onto
Required property.
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
The ID or name of the image to boot with
Optional property.
Name of keypair to inject into the server
Optional property.
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.
Optional server name
Optional property.
An ordered list of nics to be added to this server, with information about connected networks, fixed ips, port etc
Optional property.
List contents:Optional property.
Map properties:Fixed IP address to specify for the port created on the requested network
Optional property.
ID of an existing port to associate with this server
Optional property.
ID of network to create a port on
Optional property.
A UUID for the set of servers being requested
Optional property.
Arbitrary key-value pairs specified by the client to help boot a server
Optional property.
List of security group names or IDs.
Optional property.
User data script to be executed by cloud-init
Optional property.
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
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
{
"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
}
}
}
}