nsxt.PolicyEdgeHighAvailabilityProfile
Explore with Pulumi AI
Create PolicyEdgeHighAvailabilityProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyEdgeHighAvailabilityProfile(name: string, args: PolicyEdgeHighAvailabilityProfileArgs, opts?: CustomResourceOptions);
@overload
def PolicyEdgeHighAvailabilityProfile(resource_name: str,
args: PolicyEdgeHighAvailabilityProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyEdgeHighAvailabilityProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
bfd_allowed_hops: Optional[float] = None,
bfd_declare_dead_multiple: Optional[float] = None,
bfd_probe_interval: Optional[float] = None,
description: Optional[str] = None,
enforcement_point: Optional[str] = None,
nsx_id: Optional[str] = None,
policy_edge_high_availability_profile_id: Optional[str] = None,
site_path: Optional[str] = None,
standby_relocation_config: Optional[PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs] = None,
tags: Optional[Sequence[PolicyEdgeHighAvailabilityProfileTagArgs]] = None)
func NewPolicyEdgeHighAvailabilityProfile(ctx *Context, name string, args PolicyEdgeHighAvailabilityProfileArgs, opts ...ResourceOption) (*PolicyEdgeHighAvailabilityProfile, error)
public PolicyEdgeHighAvailabilityProfile(string name, PolicyEdgeHighAvailabilityProfileArgs args, CustomResourceOptions? opts = null)
public PolicyEdgeHighAvailabilityProfile(String name, PolicyEdgeHighAvailabilityProfileArgs args)
public PolicyEdgeHighAvailabilityProfile(String name, PolicyEdgeHighAvailabilityProfileArgs args, CustomResourceOptions options)
type: nsxt:PolicyEdgeHighAvailabilityProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PolicyEdgeHighAvailabilityProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PolicyEdgeHighAvailabilityProfileArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PolicyEdgeHighAvailabilityProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyEdgeHighAvailabilityProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyEdgeHighAvailabilityProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var policyEdgeHighAvailabilityProfileResource = new Nsxt.PolicyEdgeHighAvailabilityProfile("policyEdgeHighAvailabilityProfileResource", new()
{
DisplayName = "string",
BfdAllowedHops = 0,
BfdDeclareDeadMultiple = 0,
BfdProbeInterval = 0,
Description = "string",
EnforcementPoint = "string",
NsxId = "string",
PolicyEdgeHighAvailabilityProfileId = "string",
SitePath = "string",
StandbyRelocationConfig = new Nsxt.Inputs.PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs
{
StandbyRelocationThreshold = 0,
},
Tags = new[]
{
new Nsxt.Inputs.PolicyEdgeHighAvailabilityProfileTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyEdgeHighAvailabilityProfile(ctx, "policyEdgeHighAvailabilityProfileResource", &nsxt.PolicyEdgeHighAvailabilityProfileArgs{
DisplayName: pulumi.String("string"),
BfdAllowedHops: pulumi.Float64(0),
BfdDeclareDeadMultiple: pulumi.Float64(0),
BfdProbeInterval: pulumi.Float64(0),
Description: pulumi.String("string"),
EnforcementPoint: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyEdgeHighAvailabilityProfileId: pulumi.String("string"),
SitePath: pulumi.String("string"),
StandbyRelocationConfig: &nsxt.PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs{
StandbyRelocationThreshold: pulumi.Float64(0),
},
Tags: nsxt.PolicyEdgeHighAvailabilityProfileTagArray{
&nsxt.PolicyEdgeHighAvailabilityProfileTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
var policyEdgeHighAvailabilityProfileResource = new PolicyEdgeHighAvailabilityProfile("policyEdgeHighAvailabilityProfileResource", PolicyEdgeHighAvailabilityProfileArgs.builder()
.displayName("string")
.bfdAllowedHops(0.0)
.bfdDeclareDeadMultiple(0.0)
.bfdProbeInterval(0.0)
.description("string")
.enforcementPoint("string")
.nsxId("string")
.policyEdgeHighAvailabilityProfileId("string")
.sitePath("string")
.standbyRelocationConfig(PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs.builder()
.standbyRelocationThreshold(0.0)
.build())
.tags(PolicyEdgeHighAvailabilityProfileTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_edge_high_availability_profile_resource = nsxt.PolicyEdgeHighAvailabilityProfile("policyEdgeHighAvailabilityProfileResource",
display_name="string",
bfd_allowed_hops=0,
bfd_declare_dead_multiple=0,
bfd_probe_interval=0,
description="string",
enforcement_point="string",
nsx_id="string",
policy_edge_high_availability_profile_id="string",
site_path="string",
standby_relocation_config={
"standby_relocation_threshold": 0,
},
tags=[{
"scope": "string",
"tag": "string",
}])
const policyEdgeHighAvailabilityProfileResource = new nsxt.PolicyEdgeHighAvailabilityProfile("policyEdgeHighAvailabilityProfileResource", {
displayName: "string",
bfdAllowedHops: 0,
bfdDeclareDeadMultiple: 0,
bfdProbeInterval: 0,
description: "string",
enforcementPoint: "string",
nsxId: "string",
policyEdgeHighAvailabilityProfileId: "string",
sitePath: "string",
standbyRelocationConfig: {
standbyRelocationThreshold: 0,
},
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyEdgeHighAvailabilityProfile
properties:
bfdAllowedHops: 0
bfdDeclareDeadMultiple: 0
bfdProbeInterval: 0
description: string
displayName: string
enforcementPoint: string
nsxId: string
policyEdgeHighAvailabilityProfileId: string
sitePath: string
standbyRelocationConfig:
standbyRelocationThreshold: 0
tags:
- scope: string
tag: string
PolicyEdgeHighAvailabilityProfile Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PolicyEdgeHighAvailabilityProfile resource accepts the following input properties:
- Display
Name string - Display name of the resource.
- Bfd
Allowed doubleHops - Value of BFD allowed hops. Default: 255.
- Bfd
Declare doubleDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- Bfd
Probe doubleInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- Description string
- Description of the resource.
- Enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Edge stringHigh Availability Profile Id - ID of the resource.
- Site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - Standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- List<Policy
Edge High Availability Profile Tag> - A list of scope + tag pairs to associate with this resource.
- Display
Name string - Display name of the resource.
- Bfd
Allowed float64Hops - Value of BFD allowed hops. Default: 255.
- Bfd
Declare float64Dead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- Bfd
Probe float64Interval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- Description string
- Description of the resource.
- Enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Edge stringHigh Availability Profile Id - ID of the resource.
- Site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - Standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config Args - Stand by relocation flag.
- []Policy
Edge High Availability Profile Tag Args - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- bfd
Allowed DoubleHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare DoubleDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe DoubleInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description String
- Description of the resource.
- enforcement
Point String - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Edge StringHigh Availability Profile Id - ID of the resource.
- site
Path String - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- List<Policy
Edge High Availability Profile Tag> - A list of scope + tag pairs to associate with this resource.
- display
Name string - Display name of the resource.
- bfd
Allowed numberHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare numberDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe numberInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description string
- Description of the resource.
- enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Edge stringHigh Availability Profile Id - ID of the resource.
- site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- Policy
Edge High Availability Profile Tag[] - A list of scope + tag pairs to associate with this resource.
- display_
name str - Display name of the resource.
- bfd_
allowed_ floathops - Value of BFD allowed hops. Default: 255.
- bfd_
declare_ floatdead_ multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd_
probe_ floatinterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description str
- Description of the resource.
- enforcement_
point str - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
edge_ strhigh_ availability_ profile_ id - ID of the resource.
- site_
path str - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby_
relocation_ Policyconfig Edge High Availability Profile Standby Relocation Config Args - Stand by relocation flag.
- Sequence[Policy
Edge High Availability Profile Tag Args] - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- bfd
Allowed NumberHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare NumberDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe NumberInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description String
- Description of the resource.
- enforcement
Point String - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Edge StringHigh Availability Profile Id - ID of the resource.
- site
Path String - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation Property MapConfig - Stand by relocation flag.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicyEdgeHighAvailabilityProfile resource produces the following output properties:
Look up Existing PolicyEdgeHighAvailabilityProfile Resource
Get an existing PolicyEdgeHighAvailabilityProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PolicyEdgeHighAvailabilityProfileState, opts?: CustomResourceOptions): PolicyEdgeHighAvailabilityProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bfd_allowed_hops: Optional[float] = None,
bfd_declare_dead_multiple: Optional[float] = None,
bfd_probe_interval: Optional[float] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
enforcement_point: Optional[str] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
policy_edge_high_availability_profile_id: Optional[str] = None,
revision: Optional[float] = None,
site_path: Optional[str] = None,
standby_relocation_config: Optional[PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs] = None,
tags: Optional[Sequence[PolicyEdgeHighAvailabilityProfileTagArgs]] = None) -> PolicyEdgeHighAvailabilityProfile
func GetPolicyEdgeHighAvailabilityProfile(ctx *Context, name string, id IDInput, state *PolicyEdgeHighAvailabilityProfileState, opts ...ResourceOption) (*PolicyEdgeHighAvailabilityProfile, error)
public static PolicyEdgeHighAvailabilityProfile Get(string name, Input<string> id, PolicyEdgeHighAvailabilityProfileState? state, CustomResourceOptions? opts = null)
public static PolicyEdgeHighAvailabilityProfile get(String name, Output<String> id, PolicyEdgeHighAvailabilityProfileState state, CustomResourceOptions options)
resources: _: type: nsxt:PolicyEdgeHighAvailabilityProfile get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Bfd
Allowed doubleHops - Value of BFD allowed hops. Default: 255.
- Bfd
Declare doubleDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- Bfd
Probe doubleInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Edge stringHigh Availability Profile Id - ID of the resource.
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - Standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- List<Policy
Edge High Availability Profile Tag> - A list of scope + tag pairs to associate with this resource.
- Bfd
Allowed float64Hops - Value of BFD allowed hops. Default: 255.
- Bfd
Declare float64Dead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- Bfd
Probe float64Interval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Edge stringHigh Availability Profile Id - ID of the resource.
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - Standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config Args - Stand by relocation flag.
- []Policy
Edge High Availability Profile Tag Args - A list of scope + tag pairs to associate with this resource.
- bfd
Allowed DoubleHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare DoubleDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe DoubleInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- enforcement
Point String - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Edge StringHigh Availability Profile Id - ID of the resource.
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- site
Path String - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- List<Policy
Edge High Availability Profile Tag> - A list of scope + tag pairs to associate with this resource.
- bfd
Allowed numberHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare numberDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe numberInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- enforcement
Point string - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- policy
Edge stringHigh Availability Profile Id - ID of the resource.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- site
Path string - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation PolicyConfig Edge High Availability Profile Standby Relocation Config - Stand by relocation flag.
- Policy
Edge High Availability Profile Tag[] - A list of scope + tag pairs to associate with this resource.
- bfd_
allowed_ floathops - Value of BFD allowed hops. Default: 255.
- bfd_
declare_ floatdead_ multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd_
probe_ floatinterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- enforcement_
point str - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- policy_
edge_ strhigh_ availability_ profile_ id - ID of the resource.
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- site_
path str - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby_
relocation_ Policyconfig Edge High Availability Profile Standby Relocation Config Args - Stand by relocation flag.
- Sequence[Policy
Edge High Availability Profile Tag Args] - A list of scope + tag pairs to associate with this resource.
- bfd
Allowed NumberHops - Value of BFD allowed hops. Default: 255.
- bfd
Declare NumberDead Multiple - Number of times a packet is missed before BFD declares the neighbor down. Default: 3.
- bfd
Probe NumberInterval - The time interval (in millisec) between probe packets for heartbeat purpose. Default: 500.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- enforcement
Point String - The ID of enforcement point under given
site_path
to manage the Edge Transport Node. Defaults to default enforcement point. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Edge StringHigh Availability Profile Id - ID of the resource.
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- site
Path String - The path of the site which the Edge Transport Node belongs to.
path
field of the existingnsxt.PolicySite
can be used here. Defaults to default site path. - standby
Relocation Property MapConfig - Stand by relocation flag.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Supporting Types
PolicyEdgeHighAvailabilityProfileStandbyRelocationConfig, PolicyEdgeHighAvailabilityProfileStandbyRelocationConfigArgs
- Standby
Relocation doubleThreshold - Standby service context relocation wait time.
- Standby
Relocation float64Threshold - Standby service context relocation wait time.
- standby
Relocation DoubleThreshold - Standby service context relocation wait time.
- standby
Relocation numberThreshold - Standby service context relocation wait time.
- standby_
relocation_ floatthreshold - Standby service context relocation wait time.
- standby
Relocation NumberThreshold - Standby service context relocation wait time.
PolicyEdgeHighAvailabilityProfileTag, PolicyEdgeHighAvailabilityProfileTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.