Module loadbalancer

loadbalancer

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.
class pulumi_openstack.loadbalancer.L7PolicyV2(resource_name, opts=None, action=None, admin_state_up=None, description=None, listener_id=None, name=None, position=None, redirect_pool_id=None, redirect_url=None, region=None, tenant_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Load Balancer L7 Policy resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • action (pulumi.Input[str]) – The L7 Policy action - can either be REDIRECT_TO_POOL, REDIRECT_TO_URL or REJECT.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the L7 Policy. A valid value is true (UP) or false (DOWN).
  • description (pulumi.Input[str]) – Human-readable description for the L7 Policy.
  • listener_id (pulumi.Input[str]) – The Listener on which the L7 Policy will be associated with. Changing this creates a new L7 Policy.
  • name (pulumi.Input[str]) – Human-readable name for the L7 Policy. Does not have to be unique.
  • position (pulumi.Input[float]) – The position of this policy on the listener. Positions start at 1.
  • redirect_pool_id (pulumi.Input[str]) – Requests matching this policy will be redirected to the pool with this ID. Only valid if action is REDIRECT_TO_POOL.
  • redirect_url (pulumi.Input[str]) – Requests matching this policy will be redirected to this URL. Only valid if action is REDIRECT_TO_URL.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Policy.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the L7 Policy. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Policy.
action = None

The L7 Policy action - can either be REDIRECT_TO_POOL, REDIRECT_TO_URL or REJECT.

admin_state_up = None

The administrative state of the L7 Policy. A valid value is true (UP) or false (DOWN).

description = None

Human-readable description for the L7 Policy.

listener_id = None

The Listener on which the L7 Policy will be associated with. Changing this creates a new L7 Policy.

name = None

Human-readable name for the L7 Policy. Does not have to be unique.

position = None

The position of this policy on the listener. Positions start at 1.

redirect_pool_id = None

Requests matching this policy will be redirected to the pool with this ID. Only valid if action is REDIRECT_TO_POOL.

redirect_url = None

Requests matching this policy will be redirected to this URL. Only valid if action is REDIRECT_TO_URL.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Policy.

tenant_id = None

Required for admins. The UUID of the tenant who owns the L7 Policy. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Policy.

static get(resource_name, id, opts=None, action=None, admin_state_up=None, description=None, listener_id=None, name=None, position=None, redirect_pool_id=None, redirect_url=None, region=None, tenant_id=None)

Get an existing L7PolicyV2 resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] action: The L7 Policy action - can either be REDIRECT_TO_POOL,

REDIRECT_TO_URL or REJECT.
Parameters:
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the L7 Policy. A valid value is true (UP) or false (DOWN).
  • description (pulumi.Input[str]) – Human-readable description for the L7 Policy.
  • listener_id (pulumi.Input[str]) – The Listener on which the L7 Policy will be associated with. Changing this creates a new L7 Policy.
  • name (pulumi.Input[str]) – Human-readable name for the L7 Policy. Does not have to be unique.
  • position (pulumi.Input[float]) – The position of this policy on the listener. Positions start at 1.
  • redirect_pool_id (pulumi.Input[str]) – Requests matching this policy will be redirected to the pool with this ID. Only valid if action is REDIRECT_TO_POOL.
  • redirect_url (pulumi.Input[str]) – Requests matching this policy will be redirected to this URL. Only valid if action is REDIRECT_TO_URL.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Policy.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the L7 Policy. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Policy.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.L7RuleV2(resource_name, opts=None, admin_state_up=None, compare_type=None, invert=None, key=None, l7policy_id=None, region=None, tenant_id=None, type=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 L7 Rule resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the L7 Rule. A valid value is true (UP) or false (DOWN).
  • compare_type (pulumi.Input[str]) – The comparison type for the L7 rule - can either be CONTAINS, STARTS_WITH, ENDS_WITH, EQUAL_TO or REGEX
  • invert (pulumi.Input[bool]) – When true the logic of the rule is inverted. For example, with invert true, equal to would become not equal to. Default is false.
  • key (pulumi.Input[str]) – The key to use for the comparison. For example, the name of the cookie to evaluate. Valid when type is set to COOKIE or HEADER.
  • l7policy_id (pulumi.Input[str]) – The ID of the L7 Policy to query. Changing this creates a new L7 Rule.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Rule.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the L7 Rule. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Rule.
  • type (pulumi.Input[str]) – The L7 Rule type - can either be COOKIE, FILE_TYPE, HEADER, HOST_NAME or PATH.
  • value (pulumi.Input[str]) – The value to use for the comparison. For example, the file type to compare.
admin_state_up = None

The administrative state of the L7 Rule. A valid value is true (UP) or false (DOWN).

compare_type = None

The comparison type for the L7 rule - can either be CONTAINS, STARTS_WITH, ENDS_WITH, EQUAL_TO or REGEX

invert = None

When true the logic of the rule is inverted. For example, with invert true, equal to would become not equal to. Default is false.

key = None

The key to use for the comparison. For example, the name of the cookie to evaluate. Valid when type is set to COOKIE or HEADER.

l7policy_id = None

The ID of the L7 Policy to query. Changing this creates a new L7 Rule.

listener_id = None

The ID of the Listener owning this resource.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Rule.

tenant_id = None

Required for admins. The UUID of the tenant who owns the L7 Rule. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Rule.

type = None

The L7 Rule type - can either be COOKIE, FILE_TYPE, HEADER, HOST_NAME or PATH.

value = None

The value to use for the comparison. For example, the file type to compare.

static get(resource_name, id, opts=None, admin_state_up=None, compare_type=None, invert=None, key=None, l7policy_id=None, listener_id=None, region=None, tenant_id=None, type=None, value=None)

Get an existing L7RuleV2 resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] admin_state_up: The administrative state of the L7 Rule.

A valid value is true (UP) or false (DOWN).
Parameters:
  • compare_type (pulumi.Input[str]) – The comparison type for the L7 rule - can either be CONTAINS, STARTS_WITH, ENDS_WITH, EQUAL_TO or REGEX
  • invert (pulumi.Input[bool]) – When true the logic of the rule is inverted. For example, with invert true, equal to would become not equal to. Default is false.
  • key (pulumi.Input[str]) – The key to use for the comparison. For example, the name of the cookie to evaluate. Valid when type is set to COOKIE or HEADER.
  • l7policy_id (pulumi.Input[str]) – The ID of the L7 Policy to query. Changing this creates a new L7 Rule.
  • listener_id (pulumi.Input[str]) – The ID of the Listener owning this resource.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new L7 Rule.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the L7 Rule. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new L7 Rule.
  • type (pulumi.Input[str]) – The L7 Rule type - can either be COOKIE, FILE_TYPE, HEADER, HOST_NAME or PATH.
  • value (pulumi.Input[str]) – The value to use for the comparison. For example, the file type to compare.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.Listener(resource_name, opts=None, admin_state_up=None, connection_limit=None, default_pool_id=None, default_tls_container_ref=None, description=None, loadbalancer_id=None, name=None, protocol=None, protocol_port=None, region=None, sni_container_refs=None, tenant_id=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 listener resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
  • connection_limit (pulumi.Input[float]) – The maximum number of connections allowed for the Listener.
  • default_pool_id (pulumi.Input[str]) – The ID of the default pool with which the Listener is associated.
  • default_tls_container_ref (pulumi.Input[str]) – A reference to a Barbican Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS. See here for more information.
  • description (pulumi.Input[str]) – Human-readable description for the Listener.
  • loadbalancer_id (pulumi.Input[str]) – The load balancer on which to provision this Listener. Changing this creates a new Listener.
  • name (pulumi.Input[str]) – Human-readable name for the Listener. Does not have to be unique.
  • protocol (pulumi.Input[str]) – The protocol - can either be TCP, HTTP, HTTPS or TERMINATED_HTTPS. Changing this creates a new Listener.
  • protocol_port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new Listener.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new Listener.
  • sni_container_refs (pulumi.Input[list]) –

    A list of references to Barbican Secrets containers which store SNI information. See here for more information.

  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the Listener. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new Listener.
admin_state_up = None

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

connection_limit = None

The maximum number of connections allowed for the Listener.

default_pool_id = None

The ID of the default pool with which the Listener is associated.

default_tls_container_ref = None

A reference to a Barbican Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS. See here for more information.

description = None

Human-readable description for the Listener.

loadbalancer_id = None

The load balancer on which to provision this Listener. Changing this creates a new Listener.

name = None

Human-readable name for the Listener. Does not have to be unique.

protocol = None

The protocol - can either be TCP, HTTP, HTTPS or TERMINATED_HTTPS. Changing this creates a new Listener.

protocol_port = None

The port on which to listen for client traffic. Changing this creates a new Listener.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new Listener.

sni_container_refs = None

A list of references to Barbican Secrets containers which store SNI information. See here for more information.

tenant_id = None

Required for admins. The UUID of the tenant who owns the Listener. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new Listener.

static get(resource_name, id, opts=None, admin_state_up=None, connection_limit=None, default_pool_id=None, default_tls_container_ref=None, description=None, loadbalancer_id=None, name=None, protocol=None, protocol_port=None, region=None, sni_container_refs=None, tenant_id=None)

Get an existing Listener resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] admin_state_up: The administrative state of the Listener.

A valid value is true (UP) or false (DOWN).
Parameters:
  • connection_limit (pulumi.Input[float]) – The maximum number of connections allowed for the Listener.
  • default_pool_id (pulumi.Input[str]) – The ID of the default pool with which the Listener is associated.
  • default_tls_container_ref (pulumi.Input[str]) –

    A reference to a Barbican Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS. See here for more information.

  • description (pulumi.Input[str]) – Human-readable description for the Listener.
  • loadbalancer_id (pulumi.Input[str]) – The load balancer on which to provision this Listener. Changing this creates a new Listener.
  • name (pulumi.Input[str]) – Human-readable name for the Listener. Does not have to be unique.
  • protocol (pulumi.Input[str]) – The protocol - can either be TCP, HTTP, HTTPS or TERMINATED_HTTPS. Changing this creates a new Listener.
  • protocol_port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new Listener.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new Listener.
  • sni_container_refs (pulumi.Input[list]) –

    A list of references to Barbican Secrets containers which store SNI information. See here for more information.

  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the Listener. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new Listener.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.LoadBalancer(resource_name, opts=None, admin_state_up=None, description=None, flavor=None, loadbalancer_provider=None, name=None, region=None, security_group_ids=None, tenant_id=None, vip_address=None, vip_subnet_id=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 loadbalancer resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
  • description (pulumi.Input[str]) – Human-readable description for the Loadbalancer.
  • flavor (pulumi.Input[str]) – The UUID of a flavor. Changing this creates a new loadbalancer.
  • loadbalancer_provider (pulumi.Input[str]) – The name of the provider. Changing this creates a new loadbalancer.
  • name (pulumi.Input[str]) – Human-readable name for the Loadbalancer. Does not have to be unique.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
  • security_group_ids (pulumi.Input[list]) – A list of security group IDs to apply to the loadbalancer. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the Loadbalancer. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new loadbalancer.
  • vip_address (pulumi.Input[str]) – The ip address of the load balancer. Changing this creates a new loadbalancer.
  • vip_subnet_id (pulumi.Input[str]) – The network on which to allocate the Loadbalancer’s address. A tenant can only create Loadbalancers on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new loadbalancer.
admin_state_up = None

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

description = None

Human-readable description for the Loadbalancer.

flavor = None

The UUID of a flavor. Changing this creates a new loadbalancer.

loadbalancer_provider = None

The name of the provider. Changing this creates a new loadbalancer.

name = None

Human-readable name for the Loadbalancer. Does not have to be unique.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.

security_group_ids = None

A list of security group IDs to apply to the loadbalancer. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

tenant_id = None

Required for admins. The UUID of the tenant who owns the Loadbalancer. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new loadbalancer.

vip_address = None

The ip address of the load balancer. Changing this creates a new loadbalancer.

vip_port_id = None

The Port ID of the Load Balancer IP.

vip_subnet_id = None

The network on which to allocate the Loadbalancer’s address. A tenant can only create Loadbalancers on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new loadbalancer.

static get(resource_name, id, opts=None, admin_state_up=None, description=None, flavor=None, loadbalancer_provider=None, name=None, region=None, security_group_ids=None, tenant_id=None, vip_address=None, vip_port_id=None, vip_subnet_id=None)

Get an existing LoadBalancer resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] admin_state_up: The administrative state of the Loadbalancer.

A valid value is true (UP) or false (DOWN).
Parameters:
  • description (pulumi.Input[str]) – Human-readable description for the Loadbalancer.
  • flavor (pulumi.Input[str]) – The UUID of a flavor. Changing this creates a new loadbalancer.
  • loadbalancer_provider (pulumi.Input[str]) – The name of the provider. Changing this creates a new loadbalancer.
  • name (pulumi.Input[str]) – Human-readable name for the Loadbalancer. Does not have to be unique.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
  • security_group_ids (pulumi.Input[list]) – A list of security group IDs to apply to the loadbalancer. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the Loadbalancer. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new loadbalancer.
  • vip_address (pulumi.Input[str]) – The ip address of the load balancer. Changing this creates a new loadbalancer.
  • vip_port_id (pulumi.Input[str]) – The Port ID of the Load Balancer IP.
  • vip_subnet_id (pulumi.Input[str]) – The network on which to allocate the Loadbalancer’s address. A tenant can only create Loadbalancers on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new loadbalancer.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.Member(resource_name, opts=None, address=None, admin_state_up=None, name=None, pool_id=None, protocol_port=None, region=None, subnet_id=None, tenant_id=None, weight=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 member resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address (pulumi.Input[str]) – The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the member. A valid value is true (UP) or false (DOWN).
  • name (pulumi.Input[str]) – Human-readable name for the member.
  • pool_id (pulumi.Input[str]) – The id of the pool that this member will be assigned to.
  • protocol_port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new member.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new member.
  • subnet_id (pulumi.Input[str]) – The subnet in which to access the member
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.
  • weight (pulumi.Input[float]) – A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2.
address = None

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

admin_state_up = None

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

name = None

Human-readable name for the member.

pool_id = None

The id of the pool that this member will be assigned to.

protocol_port = None

The port on which to listen for client traffic. Changing this creates a new member.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new member.

subnet_id = None

The subnet in which to access the member

tenant_id = None

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

weight = None

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

static get(resource_name, id, opts=None, address=None, admin_state_up=None, name=None, pool_id=None, protocol_port=None, region=None, subnet_id=None, tenant_id=None, weight=None)

Get an existing Member resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] address: The IP address of the member to receive traffic from

the load balancer. Changing this creates a new member.
Parameters:
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the member. A valid value is true (UP) or false (DOWN).
  • name (pulumi.Input[str]) – Human-readable name for the member.
  • pool_id (pulumi.Input[str]) – The id of the pool that this member will be assigned to.
  • protocol_port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new member.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new member.
  • subnet_id (pulumi.Input[str]) – The subnet in which to access the member
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.
  • weight (pulumi.Input[float]) – A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.MemberV1(resource_name, opts=None, address=None, admin_state_up=None, pool_id=None, port=None, region=None, tenant_id=None, weight=None, __props__=None, __name__=None, __opts__=None)

Manages a V1 load balancer member resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address (pulumi.Input[str]) – The IP address of the member. Changing this creates a new member.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the member. Acceptable values are ‘true’ and ‘false’. Changing this value updates the state of the existing member.
  • pool_id (pulumi.Input[str]) – The ID of the LB pool. Changing this creates a new member.
  • port (pulumi.Input[float]) – An integer representing the port on which the member is hosted. Changing this creates a new member.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
  • tenant_id (pulumi.Input[str]) – The owner of the member. Required if admin wants to create a member for another tenant. Changing this creates a new member.
address = None

The IP address of the member. Changing this creates a new member.

admin_state_up = None

The administrative state of the member. Acceptable values are ‘true’ and ‘false’. Changing this value updates the state of the existing member.

pool_id = None

The ID of the LB pool. Changing this creates a new member.

port = None

An integer representing the port on which the member is hosted. Changing this creates a new member.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.

tenant_id = None

The owner of the member. Required if admin wants to create a member for another tenant. Changing this creates a new member.

static get(resource_name, id, opts=None, address=None, admin_state_up=None, pool_id=None, port=None, region=None, tenant_id=None, weight=None)

Get an existing MemberV1 resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] address: The IP address of the member. Changing this creates a

new member.
Parameters:
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the member. Acceptable values are ‘true’ and ‘false’. Changing this value updates the state of the existing member.
  • pool_id (pulumi.Input[str]) – The ID of the LB pool. Changing this creates a new member.
  • port (pulumi.Input[float]) – An integer representing the port on which the member is hosted. Changing this creates a new member.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
  • tenant_id (pulumi.Input[str]) – The owner of the member. Required if admin wants to create a member for another tenant. Changing this creates a new member.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.Monitor(resource_name, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, name=None, pool_id=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 monitor resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
  • delay (pulumi.Input[float]) – The time, in seconds, between sending probes to members.
  • expected_codes (pulumi.Input[str]) – Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
  • http_method (pulumi.Input[str]) – Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
  • max_retries (pulumi.Input[float]) – Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10..
  • name (pulumi.Input[str]) – The Name of the Monitor.
  • pool_id (pulumi.Input[str]) – The id of the pool that this monitor will be assigned to.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
  • timeout (pulumi.Input[float]) – Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
  • type (pulumi.Input[str]) – The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
  • url_path (pulumi.Input[str]) – Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.
admin_state_up = None

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

delay = None

The time, in seconds, between sending probes to members.

expected_codes = None

Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.

http_method = None

Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.

max_retries = None

Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10..

name = None

The Name of the Monitor.

pool_id = None

The id of the pool that this monitor will be assigned to.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.

tenant_id = None

Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.

timeout = None

Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.

type = None

The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the load balancer to verify the member state. Changing this creates a new monitor.

url_path = None

Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

static get(resource_name, id, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, name=None, pool_id=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None)

Get an existing Monitor resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] admin_state_up: The administrative state of the monitor.

A valid value is true (UP) or false (DOWN).
Parameters:
  • delay (pulumi.Input[float]) – The time, in seconds, between sending probes to members.
  • expected_codes (pulumi.Input[str]) – Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
  • http_method (pulumi.Input[str]) – Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
  • max_retries (pulumi.Input[float]) – Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10..
  • name (pulumi.Input[str]) – The Name of the Monitor.
  • pool_id (pulumi.Input[str]) – The id of the pool that this monitor will be assigned to.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
  • timeout (pulumi.Input[float]) – Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
  • type (pulumi.Input[str]) – The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
  • url_path (pulumi.Input[str]) – Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.MonitorV1(resource_name, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None, __name__=None, __opts__=None)

Manages a V1 load balancer monitor resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[str]) – The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
  • delay (pulumi.Input[float]) – The time, in seconds, between sending probes to members. Changing this creates a new monitor.
  • expected_codes (pulumi.Input[str]) – Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
  • http_method (pulumi.Input[str]) – Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
  • max_retries (pulumi.Input[float]) – Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
  • tenant_id (pulumi.Input[str]) – The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
  • timeout (pulumi.Input[float]) – Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
  • type (pulumi.Input[str]) – The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
  • url_path (pulumi.Input[str]) – Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.
admin_state_up = None

The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.

delay = None

The time, in seconds, between sending probes to members. Changing this creates a new monitor.

expected_codes = None

Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.

http_method = None

Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.

max_retries = None

Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.

tenant_id = None

The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.

timeout = None

Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.

type = None

The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.

url_path = None

Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

static get(resource_name, id, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None)

Get an existing MonitorV1 resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] admin_state_up: The administrative state of the monitor.

Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
Parameters:
  • delay (pulumi.Input[float]) – The time, in seconds, between sending probes to members. Changing this creates a new monitor.
  • expected_codes (pulumi.Input[str]) – Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
  • http_method (pulumi.Input[str]) – Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
  • max_retries (pulumi.Input[float]) – Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
  • tenant_id (pulumi.Input[str]) – The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
  • timeout (pulumi.Input[float]) – Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
  • type (pulumi.Input[str]) – The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
  • url_path (pulumi.Input[str]) – Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.Pool(resource_name, opts=None, admin_state_up=None, description=None, lb_method=None, listener_id=None, loadbalancer_id=None, name=None, persistence=None, protocol=None, region=None, tenant_id=None, __props__=None, __name__=None, __opts__=None)

Manages a V2 pool resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the pool. A valid value is true (UP) or false (DOWN).
  • description (pulumi.Input[str]) – Human-readable description for the pool.
  • lb_method (pulumi.Input[str]) – The load balancing algorithm to distribute traffic to the pool’s members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
  • listener_id (pulumi.Input[str]) – The Listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.
  • loadbalancer_id (pulumi.Input[str]) – The load balancer on which to provision this pool. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.
  • name (pulumi.Input[str]) – Human-readable name for the pool.
  • persistence (pulumi.Input[dict]) – Omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. Changing this creates a new pool.
  • protocol (pulumi.Input[str]) – See Argument Reference above.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new pool.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the pool. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new pool.
admin_state_up = None

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

description = None

Human-readable description for the pool.

lb_method = None

The load balancing algorithm to distribute traffic to the pool’s members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.

listener_id = None

The Listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

loadbalancer_id = None

The load balancer on which to provision this pool. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

name = None

Human-readable name for the pool.

persistence = None

Omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. Changing this creates a new pool.

protocol = None

See Argument Reference above.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new pool.

tenant_id = None

Required for admins. The UUID of the tenant who owns the pool. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new pool.

static get(resource_name, id, opts=None, admin_state_up=None, description=None, lb_method=None, listener_id=None, loadbalancer_id=None, name=None, persistence=None, protocol=None, region=None, tenant_id=None)

Get an existing Pool resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] admin_state_up: The administrative state of the pool.

A valid value is true (UP) or false (DOWN).
Parameters:
  • description (pulumi.Input[str]) – Human-readable description for the pool.
  • lb_method (pulumi.Input[str]) – The load balancing algorithm to distribute traffic to the pool’s members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
  • listener_id (pulumi.Input[str]) – The Listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.
  • loadbalancer_id (pulumi.Input[str]) – The load balancer on which to provision this pool. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.
  • name (pulumi.Input[str]) – Human-readable name for the pool.
  • persistence (pulumi.Input[dict]) – Omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. Changing this creates a new pool.
  • protocol (pulumi.Input[str]) – See Argument Reference above.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new pool.
  • tenant_id (pulumi.Input[str]) – Required for admins. The UUID of the tenant who owns the pool. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new pool.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.PoolV1(resource_name, opts=None, lb_method=None, lb_provider=None, monitor_ids=None, name=None, protocol=None, region=None, subnet_id=None, tenant_id=None, __props__=None, __name__=None, __opts__=None)

Manages a V1 load balancer pool resource within OpenStack.

The member block is deprecated in favor of the loadbalancer.MemberV1 resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • lb_method (pulumi.Input[str]) – The algorithm used to distribute load between the members of the pool. The current specification supports ‘ROUND_ROBIN’ and ‘LEAST_CONNECTIONS’ as valid values for this attribute.
  • lb_provider (pulumi.Input[str]) – The backend load balancing provider. For example: haproxy, F5, etc.
  • monitor_ids (pulumi.Input[list]) – A list of IDs of monitors to associate with the pool.
  • name (pulumi.Input[str]) – The name of the pool. Changing this updates the name of the existing pool.
  • protocol (pulumi.Input[str]) – The protocol used by the pool members, you can use either ‘TCP, ‘HTTP’, or ‘HTTPS’. Changing this creates a new pool.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
  • subnet_id (pulumi.Input[str]) – The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
  • tenant_id (pulumi.Input[str]) – The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
lb_method = None

The algorithm used to distribute load between the members of the pool. The current specification supports ‘ROUND_ROBIN’ and ‘LEAST_CONNECTIONS’ as valid values for this attribute.

lb_provider = None

The backend load balancing provider. For example: haproxy, F5, etc.

monitor_ids = None

A list of IDs of monitors to associate with the pool.

name = None

The name of the pool. Changing this updates the name of the existing pool.

protocol = None

The protocol used by the pool members, you can use either ‘TCP, ‘HTTP’, or ‘HTTPS’. Changing this creates a new pool.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.

subnet_id = None

The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.

tenant_id = None

The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.

static get(resource_name, id, opts=None, lb_method=None, lb_provider=None, monitor_ids=None, name=None, protocol=None, region=None, subnet_id=None, tenant_id=None)

Get an existing PoolV1 resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] lb_method: The algorithm used to distribute load between the

members of the pool. The current specification supports ‘ROUND_ROBIN’ and ‘LEAST_CONNECTIONS’ as valid values for this attribute.
Parameters:
  • lb_provider (pulumi.Input[str]) – The backend load balancing provider. For example: haproxy, F5, etc.
  • monitor_ids (pulumi.Input[list]) – A list of IDs of monitors to associate with the pool.
  • name (pulumi.Input[str]) – The name of the pool. Changing this updates the name of the existing pool.
  • protocol (pulumi.Input[str]) – The protocol used by the pool members, you can use either ‘TCP, ‘HTTP’, or ‘HTTPS’. Changing this creates a new pool.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
  • subnet_id (pulumi.Input[str]) – The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
  • tenant_id (pulumi.Input[str]) – The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.loadbalancer.Vip(resource_name, opts=None, address=None, admin_state_up=None, conn_limit=None, description=None, floating_ip=None, name=None, persistence=None, pool_id=None, port=None, protocol=None, region=None, subnet_id=None, tenant_id=None, __props__=None, __name__=None, __opts__=None)

Manages a V1 load balancer vip resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address (pulumi.Input[str]) – The IP address of the vip. Changing this creates a new vip.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
  • conn_limit (pulumi.Input[float]) – The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
  • description (pulumi.Input[str]) – Human-readable description for the vip. Changing this updates the description of the existing vip.
  • floating_ip (pulumi.Input[str]) – A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
  • name (pulumi.Input[str]) – The name of the vip. Changing this updates the name of the existing vip.
  • persistence (pulumi.Input[dict]) – Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
  • pool_id (pulumi.Input[str]) – The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
  • port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new vip.
  • protocol (pulumi.Input[str]) – The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
  • subnet_id (pulumi.Input[str]) – The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
  • tenant_id (pulumi.Input[str]) – The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
address = None

The IP address of the vip. Changing this creates a new vip.

admin_state_up = None

The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.

conn_limit = None

The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.

description = None

Human-readable description for the vip. Changing this updates the description of the existing vip.

floating_ip = None

A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.

name = None

The name of the vip. Changing this updates the name of the existing vip.

persistence = None

Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.

pool_id = None

The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.

port = None

The port on which to listen for client traffic. Changing this creates a new vip.

port_id = None

Port UUID for this VIP at associated floating IP (if any).

protocol = None

The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.

region = None

The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.

subnet_id = None

The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.

tenant_id = None

The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

static get(resource_name, id, opts=None, address=None, admin_state_up=None, conn_limit=None, description=None, floating_ip=None, name=None, persistence=None, pool_id=None, port=None, port_id=None, protocol=None, region=None, subnet_id=None, tenant_id=None)

Get an existing Vip resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] address: The IP address of the vip. Changing this creates a new

vip.
Parameters:
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
  • conn_limit (pulumi.Input[float]) – The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
  • description (pulumi.Input[str]) – Human-readable description for the vip. Changing this updates the description of the existing vip.
  • floating_ip (pulumi.Input[str]) – A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
  • name (pulumi.Input[str]) – The name of the vip. Changing this updates the name of the existing vip.
  • persistence (pulumi.Input[dict]) – Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
  • pool_id (pulumi.Input[str]) – The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
  • port (pulumi.Input[float]) – The port on which to listen for client traffic. Changing this creates a new vip.
  • port_id (pulumi.Input[str]) – Port UUID for this VIP at associated floating IP (if any).
  • protocol (pulumi.Input[str]) – The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
  • subnet_id (pulumi.Input[str]) – The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
  • tenant_id (pulumi.Input[str]) – The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str