Unsupported Heat Resource Types

These resources are enabled, but are not officially supported.

OS::Aodh::CombinationAlarm

Note

DEPRECATED since 7.0.0 (Newton) - The combination alarm is deprecated and disabled by default in Aodh.

Note

Available since 2014.1 (Icehouse)

A resource that implements combination of Aodh alarms.

Allows to use alarm as a combination of other alarms with some operator: activate this alarm if any alarm in combination has been activated or if all alarms in combination have been activated.

Required Properties

alarm_ids

List of alarm identifiers to combine.

List value expected.

Can be updated without replacement.

The length must be at least 1.

Optional Properties

alarm_actions

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

List value expected.

Can be updated without replacement.

alarm_queues

Note

Available since 8.0.0 (Ocata)

A list of Zaqar queues to post to when state transitions to alarm.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

List contents:

*

String value expected.

Can be updated without replacement.

Value must be of type zaqar.queue

description

Description for the alarm.

String value expected.

Can be updated without replacement.

enabled

True if alarm evaluation/actioning is enabled.

Boolean value expected.

Can be updated without replacement.

Defaults to “true”.

insufficient_data_actions

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

List value expected.

Can be updated without replacement.

insufficient_data_queues

Note

Available since 8.0.0 (Ocata)

A list of Zaqar queues to post to when state transitions to insufficient-data.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

List contents:

*

String value expected.

Can be updated without replacement.

Value must be of type zaqar.queue

ok_actions

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

List value expected.

Can be updated without replacement.

ok_queues

Note

Available since 8.0.0 (Ocata)

A list of Zaqar queues to post to when state transitions to ok.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

List contents:

*

String value expected.

Can be updated without replacement.

Value must be of type zaqar.queue

operator

Operator used to combine the alarms.

String value expected.

Can be updated without replacement.

Allowed values: and, or

repeat_actions

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

Boolean value expected.

Can be updated without replacement.

Defaults to “true”.

severity

Note

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to “low”.

Allowed values: low, moderate, critical

time_constraints

Note

Available since 5.0.0 (Liberty)

Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds.

List value expected.

Updates cause replacement.

Defaults to “[]”.

List contents:

*

Map value expected.

Updates cause replacement.

Map properties:

description

Description for the time constraint.

String value expected.

Updates cause replacement.

duration

Duration for the time constraint.

Integer value expected.

Updates cause replacement.

The value must be at least 0.

name

Name for the time constraint.

String value expected.

Updates cause replacement.

start

Start time for the time constraint. A CRON expression property.

String value expected.

Updates cause replacement.

Value must be of type cron_expression

timezone

Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’).

String value expected.

Updates cause replacement.

Value must be of type timezone

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::CombinationAlarm
    properties:
      alarm_actions: [Value, Value, ...]
      alarm_ids: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      description: String
      enabled: Boolean
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      operator: String
      repeat_actions: Boolean
      severity: String
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

OS::Designate::Domain

Note

DEPRECATED since 8.0.0 (Ocata) - Use OS::Designate::Zone instead.

Note

Available since 5.0.0 (Liberty)

Heat Template Resource for Designate Domain.

Designate provides DNS-as-a-Service services for OpenStack. So, domain is a realm with an identification string, unique in DNS.

Required Properties

email

Domain email.

String value expected.

Can be updated without replacement.

name

Domain name.

String value expected.

Updates cause replacement.

The length must be no greater than 255.

Optional Properties

description

Description of domain.

String value expected.

Can be updated without replacement.

The length must be no greater than 160.

ttl

Time To Live (Seconds).

Integer value expected.

Can be updated without replacement.

The value must be in the range 1 to 2147483647.

Attributes

serial

DNS domain serial.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Designate::Domain
    properties:
      description: String
      email: String
      name: String
      ttl: Integer

OS::Designate::Record

Note

DEPRECATED since 8.0.0 (Ocata) - Use OS::Designate::RecordSet instead.

Note

Available since 5.0.0 (Liberty)

Heat Template Resource for Designate Record.

Designate provides DNS-as-a-Service services for OpenStack. Record is storage unit in DNS. So, DNS name server is a server that stores the DNS records for a domain. Each record has a type and type-specific data.

Required Properties

data

DNS record data, varies based on the type of record. For more details, please refer rfc 1035.

String value expected.

Can be updated without replacement.

domain

DNS Domain id or name.

String value expected.

Updates cause replacement.

Value must be of type designate.domain

name

Record name.

String value expected.

Updates cause replacement.

The length must be no greater than 255.

type

DNS Record type.

String value expected.

Can be updated without replacement.

Allowed values: A, AAAA, CNAME, MX, SRV, TXT, SPF, NS, PTR, SSHFP, SOA

Optional Properties

description

Description of record.

String value expected.

Can be updated without replacement.

The length must be no greater than 160.

priority

DNS record priority. It is considered only for MX and SRV types, otherwise, it is ignored.

Integer value expected.

Can be updated without replacement.

The value must be in the range 0 to 65536.

ttl

Time To Live (Seconds).

Integer value expected.

Can be updated without replacement.

The value must be in the range 1 to 2147483647.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Designate::Record
    properties:
      data: String
      description: String
      domain: String
      name: String
      priority: Integer
      ttl: Integer
      type: String

OS::Glance::Image

Note

DEPRECATED since 8.0.0 (Ocata) - Creating a Glance Image based on an existing URL location requires the Glance v1 API, which is deprecated.

Note

Available since 2014.2 (Juno)

A resource managing images in Glance.

A resource provides managing images that are meant to be used with other services.

Required Properties

container_format

Container format of image.

String value expected.

Updates cause replacement.

Allowed values: ami, ari, aki, bare, ova, ovf

disk_format

Disk format of image.

String value expected.

Updates cause replacement.

Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso

location

URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify “swift://example.com/container/obj”.

String value expected.

Updates cause replacement.

Optional Properties

architecture

Note

Available since 7.0.0 (Newton)

Operating system architecture.

String value expected.

Can be updated without replacement.

extra_properties

Note

Available since 7.0.0 (Newton)

Arbitrary properties to associate with the image.

Map value expected.

Can be updated without replacement.

Defaults to “{}”.

id

The image ID. Glance will generate a UUID if not specified.

String value expected.

Updates cause replacement.

is_public

Scope of image accessibility. Public or private. Default value is False means private. Note: The policy setting of glance allows only users with admin roles to create public image by default.

Boolean value expected.

Updates cause replacement.

Defaults to “False”.

kernel_id

Note

Available since 7.0.0 (Newton)

ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.

String value expected.

Can be updated without replacement.

Value must match pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$

min_disk

Amount of disk space (in GB) required to boot image. Default value is 0 if not specified and means no limit on the disk size.

Integer value expected.

Updates cause replacement.

Defaults to “0”.

The value must be at least 0.

min_ram

Amount of ram (in MB) required to boot image. Default value is 0 if not specified and means no limit on the ram size.

Integer value expected.

Updates cause replacement.

Defaults to “0”.

The value must be at least 0.

name

Name for the image. The name of an image is not unique to a Image Service node.

String value expected.

Updates cause replacement.

os_distro

Note

Available since 7.0.0 (Newton)

The common name of the operating system distribution in lowercase.

String value expected.

Can be updated without replacement.

owner

Note

Available since 7.0.0 (Newton)

Owner of the image.

String value expected.

Can be updated without replacement.

protected

Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted.

Boolean value expected.

Updates cause replacement.

Defaults to “False”.

ramdisk_id

Note

Available since 7.0.0 (Newton)

ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.

String value expected.

Can be updated without replacement.

Value must match pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$

tags

Note

Available since 7.0.0 (Newton)

List of image tags.

List value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Glance::Image
    properties:
      architecture: String
      container_format: String
      disk_format: String
      extra_properties: {...}
      id: String
      is_public: Boolean
      kernel_id: String
      location: String
      min_disk: Integer
      min_ram: Integer
      name: String
      os_distro: String
      owner: String
      protected: Boolean
      ramdisk_id: String
      tags: [Value, Value, ...]

OS::Heat::HARestarter

Note

DEPRECATED since 2015.1 (Kilo) - The HARestarter resource type is deprecated and will be removed in a future release of Heat, once it has support for auto-healing any type of resource. Note that HARestarter does *not* actually restart servers - it deletes and then recreates them. It also does the same to all dependent resources, and may therefore exhibit unexpected and undesirable behaviour. Instead, use the mark-unhealthy API to mark a resource as needing replacement, and then a stack update to perform the replacement while respecting the dependencies and not deleting them unnecessarily.

Required Properties

InstanceId

Instance ID to be restarted.

String value expected.

Updates cause replacement.

Value must be of type nova.server

Attributes

AlarmUrl

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

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::HARestarter
    properties:
      InstanceId: String

OS::Neutron::ExtraRoute

Note

UNSUPPORTED - Use this resource at your own risk.

Resource for specifying extra routes for Neutron router.

Resource allows to specify nexthop IP and destination network for router.

Required Properties

destination

Network in CIDR notation.

String value expected.

Updates cause replacement.

nexthop

Nexthop IP address.

String value expected.

Updates cause replacement.

router_id

The router id.

String value expected.

Updates cause replacement.

Value must be of type neutron.router

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::ExtraRoute
    properties:
      destination: String
      nexthop: String
      router_id: String

OS::Neutron::FlowClassifier

Note

UNSUPPORTED since 8.0.0 (Ocata)

“Heat Template Resource for networking-sfc flow-classifier.

This resource used to select the traffic that can access the service chain. Traffic that matches any flow classifier will be directed to the first port in the chain.

Optional Properties

description

Description for the Flow Classifier.

String value expected.

Can be updated without replacement.

destination_ip_prefix

Destination IP prefix or subnet.

String value expected.

Updates cause replacement.

Value must be of type net_cidr

destination_port_range_max

Destination protocol port maximum.

Integer value expected.

Updates cause replacement.

The value must be in the range 1 to 65535.

destination_port_range_min

Destination protocol port minimum.

Integer value expected.

Updates cause replacement.

The value must be in the range 1 to 65535.

ethertype

L2 ethertype.

String value expected.

Updates cause replacement.

Defaults to “IPv4”.

Allowed values: IPv4, IPv6

logical_destination_port

ID or name of the neutron destination port.

String value expected.

Updates cause replacement.

Value must be of type neutron.port

logical_source_port

ID or name of the neutron source port.

String value expected.

Updates cause replacement.

Value must be of type neutron.port

name

Name of the Flow Classifier.

String value expected.

Can be updated without replacement.

protocol

IP Protocol for the Flow Classifier.

String value expected.

Updates cause replacement.

Allowed values: tcp, udp, icmp

source_ip_prefix

Source IP prefix or subnet.

String value expected.

Updates cause replacement.

Value must be of type net_cidr

source_port_range_max

Source protocol port Maximum.

Integer value expected.

Updates cause replacement.

The value must be in the range 1 to 65535.

source_port_range_min

Source protocol port Minimum.

Integer value expected.

Updates cause replacement.

The value must be in the range 1 to 65535.

l7_parameters

Note

UNSUPPORTED - Currently, no value is supported for this option.

Dictionary of L7-parameters.

Map value expected.

Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FlowClassifier
    properties:
      description: String
      destination_ip_prefix: String
      destination_port_range_max: Integer
      destination_port_range_min: Integer
      ethertype: String
      logical_destination_port: String
      logical_source_port: String
      name: String
      protocol: String
      source_ip_prefix: String
      source_port_range_max: Integer
      source_port_range_min: Integer

OS::Neutron::HealthMonitor

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

A resource for managing health monitors for loadbalancers in Neutron.

A health monitor is used to determine whether or not back-end members of the VIP’s pool are usable for processing a request. A pool can have several health monitors associated with it. There are different types of health monitors supported by the OpenStack LBaaS service:

  • PING: used to ping the members using ICMP.
  • TCP: used to connect to the members using TCP.
  • HTTP: used to send an HTTP request to the member.
  • HTTPS: used to send a secure HTTP request to the member.

Required Properties

delay

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

Integer value expected.

Can be updated without replacement.

max_retries

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

Integer value expected.

Can be updated without replacement.

timeout

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

Integer value expected.

Can be updated without replacement.

type

One of predefined health monitor types.

String value expected.

Updates cause replacement.

Allowed values: PING, TCP, HTTP, HTTPS

Optional Properties

admin_state_up

The administrative state of the health monitor.

Boolean value expected.

Can be updated without replacement.

Defaults to “True”.

expected_codes

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

String value expected.

Can be updated without replacement.

http_method

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

String value expected.

Can be updated without replacement.

url_path

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

String value expected.

Can be updated without replacement.

Attributes

admin_state_up

The administrative state of this health monitor.

delay

The minimum time in milliseconds 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

Detailed information about resource.

tenant_id

Tenant owning the health monitor.

timeout

Maximum number of milliseconds 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: 2015-04-30
...
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

OS::Neutron::LoadBalancer

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

Note

Available since 2014.1 (Icehouse)

A resource to link a neutron pool with servers.

A loadbalancer allows linking a neutron pool with specified servers to some port.

Required Properties

pool_id

The ID of the load balancing pool.

String value expected.

Can be updated without replacement.

protocol_port

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

Integer value expected.

Updates cause replacement.

The value must be in the range 0 to 65535.

Optional Properties

members

The list of Nova server IDs load balanced.

List value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LoadBalancer
    properties:
      members: [Value, Value, ...]
      pool_id: String
      protocol_port: Integer

OS::Neutron::Pool

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

A resource for managing load balancer pools in Neutron.

A load balancing pool is a logical set of devices, such as web servers, that you group together to receive and process traffic. The loadbalancing function chooses a member of the pool according to the configured load balancing method to handle the new requests or connections received on the VIP address. There is only one pool for a VIP.

Required Properties

lb_method

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

String value expected.

Can be updated without replacement.

Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP

protocol

Protocol for balancing.

String value expected.

Updates cause replacement.

Allowed values: TCP, HTTP, HTTPS

subnet

Note

Available since 2014.2 (Juno)

The subnet for the port on which the members of the pool will be connected.

String value expected.

Updates cause replacement.

Value must be of type neutron.subnet

vip

IP address and port of the pool.

Map value expected.

Updates cause replacement.

Map properties:

address

IP address of the vip.

String value expected.

Updates cause replacement.

Value must be of type ip_addr

admin_state_up

The administrative state of this vip.

Boolean value expected.

Updates cause replacement.

Defaults to “True”.

connection_limit

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

Integer value expected.

Updates cause replacement.

description

Description of the vip.

String value expected.

Updates cause replacement.

name

Name of the vip.

String value expected.

Updates cause replacement.

protocol_port

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

Integer value expected.

Updates cause replacement.

session_persistence

Configuration of session persistence.

Map value expected.

Updates cause replacement.

Map properties:

type

Method of implementation of session persistence feature.

String value expected.

Updates cause replacement.

Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE

subnet

Subnet of the vip.

String value expected.

Updates cause replacement.

Value must be of type neutron.subnet

Optional Properties

admin_state_up

The administrative state of this pool.

Boolean value expected.

Can be updated without replacement.

Defaults to “True”.

description

Description of the pool.

String value expected.

Can be updated without replacement.

monitors

List of health monitors associated with the pool.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

name

Name of the pool.

String value expected.

Updates cause replacement.

provider

Note

Available since 5.0.0 (Liberty)

LBaaS provider to implement this load balancer instance.

String value expected.

Updates cause replacement.

Value must be of type neutron.lb.provider

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.

provider

Note

Available since 5.0.0 (Liberty)

Provider implementing this load balancer instance.

show

Detailed information about resource.

subnet_id

The subnet for the port on which the members of the pool will be connected.

tenant_id

Tenant owning the pool.

vip

Vip associated with the pool.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Pool
    properties:
      admin_state_up: Boolean
      description: String
      lb_method: String
      monitors: [Value, Value, ...]
      name: String
      protocol: String
      provider: String
      subnet: String
      vip: {"session_persistence": {"cookie_name": String, "type": String}, "subnet": String, "name": String, "address": String, "protocol_port": Integer, "connection_limit": Integer, "admin_state_up": Boolean, "description": String}

OS::Neutron::PoolMember

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

Note

Available since 2014.1 (Icehouse)

A resource to handle loadbalancer members.

A pool member represents the application running on backend server.

Required Properties

address

IP address of the pool member on the pool network.

String value expected.

Updates cause replacement.

Value must be of type ip_addr

pool_id

The ID of the load balancing pool.

String value expected.

Can be updated without replacement.

protocol_port

TCP port on which the pool member listens for requests or connections.

Integer value expected.

Updates cause replacement.

The value must be in the range 0 to 65535.

Optional Properties

admin_state_up

The administrative state of the pool member.

Boolean value expected.

Updates cause replacement.

Defaults to “True”.

weight

Weight of pool member in the pool (default to 1).

Integer value expected.

Can be updated without replacement.

The value must be in the range 0 to 256.

Attributes

address

IP address of the pool member.

admin_state_up

The administrative state of this pool member.

pool_id

The ID of the load balancing pool.

protocol_port

TCP port on which the pool member listens for requests or connections.

show

Detailed information about resource.

tenant_id

Tenant owning the pool member.

weight

Weight of the pool member in the pool.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::PoolMember
    properties:
      address: String
      admin_state_up: Boolean
      pool_id: String
      protocol_port: Integer
      weight: Integer

OS::Neutron::PortChain

Note

UNSUPPORTED since 8.0.0 (Ocata)

A resource for neutron networking-sfc.

This resource used to define the service function path by arranging networking-sfc port-pair-groups and set of flow classifiers, to specify the classified traffic flows to enter the chain.

Required Properties

port_pair_groups

A list of port pair groups to apply to the Port Chain.

List value expected.

Can be updated without replacement.

List contents:

*

Port Pair Group ID or Name .

String value expected.

Can be updated without replacement.

Value must be of type neutron.port_pair_group

Optional Properties

chain_parameters

Dictionary of chain parameters. Currently, only correlation=mpls is supported by default.

Map value expected.

Updates cause replacement.

Defaults to “{‘correlation’: ‘mpls’}”.

description

Description for the Port Chain.

String value expected.

Can be updated without replacement.

flow_classifiers

A list of flow classifiers to apply to the Port Chain.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

List contents:

*

Flow Classifier ID or Name .

String value expected.

Can be updated without replacement.

Value must be of type neutron.flow_classifier

name

Name of the Port Chain.

String value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::PortChain
    properties:
      chain_parameters: {...}
      description: String
      flow_classifiers: [String, String, ...]
      name: String
      port_pair_groups: [String, String, ...]

OS::Neutron::PortPair

Note

UNSUPPORTED since 7.0.0 (Newton)

A resource for neutron networking-sfc port-pair.

This plug-in requires networking-sfc>=1.0.0. So to enable this plug-in, install this library and restart the heat-engine.

A Port Pair represents a service function instance. The ingress port and the egress port of the service function may be specified. If a service function has one bidirectional port, the ingress port has the same value as the egress port.

Required Properties

egress

ID or name of the egress neutron port.

String value expected.

Updates cause replacement.

Value must be of type neutron.port

ingress

ID or name of the ingress neutron port.

String value expected.

Updates cause replacement.

Value must be of type neutron.port

Optional Properties

description

Description for the Port Pair.

String value expected.

Can be updated without replacement.

name

Name for the Port Pair.

String value expected.

Can be updated without replacement.

service_function_parameters

Dictionary of service function parameter. Currently only correlation=None is supported.

Map value expected.

Updates cause replacement.

Defaults to “{‘correlation’: None}”.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::PortPair
    properties:
      description: String
      egress: String
      ingress: String
      name: String
      service_function_parameters: {...}

OS::Neutron::PortPairGroup

Note

UNSUPPORTED since 8.0.0 (Ocata)

Heat Template Resource for networking-sfc port-pair-group.

Multiple port-pairs may be included in a port-pair-group to allow the specification of a set of functionally equivalent Service Functions that can be be used for load distribution.

Required Properties

port_pairs

A list of Port Pair IDs or names to apply.

List value expected.

Can be updated without replacement.

List contents:

*

Port Pair ID or name .

String value expected.

Can be updated without replacement.

Value must be of type neutron.port_pair

Optional Properties

description

Description for the Port Pair Group.

String value expected.

Can be updated without replacement.

name

Name for the Port Pair Group.

String value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::PortPairGroup
    properties:
      description: String
      name: String
      port_pairs: [String, String, ...]