Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyStaticRouteBfdPeer
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyStaticRouteBfdPeer

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyStaticRouteBfdPeer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyStaticRouteBfdPeer(name: string, args: PolicyStaticRouteBfdPeerArgs, opts?: CustomResourceOptions);
    @overload
def PolicyStaticRouteBfdPeer(resource_name: str,
                             args: PolicyStaticRouteBfdPeerArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def PolicyStaticRouteBfdPeer(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             bfd_profile_path: Optional[str] = None,
                             display_name: Optional[str] = None,
                             gateway_path: Optional[str] = None,
                             peer_address: Optional[str] = None,
                             description: Optional[str] = None,
                             enabled: Optional[bool] = None,
                             nsx_id: Optional[str] = None,
                             policy_static_route_bfd_peer_id: Optional[str] = None,
                             source_addresses: Optional[Sequence[str]] = None,
                             tags: Optional[Sequence[PolicyStaticRouteBfdPeerTagArgs]] = None)
    func NewPolicyStaticRouteBfdPeer(ctx *Context, name string, args PolicyStaticRouteBfdPeerArgs, opts ...ResourceOption) (*PolicyStaticRouteBfdPeer, error)
    public PolicyStaticRouteBfdPeer(string name, PolicyStaticRouteBfdPeerArgs args, CustomResourceOptions? opts = null)
    public PolicyStaticRouteBfdPeer(String name, PolicyStaticRouteBfdPeerArgs args)
public PolicyStaticRouteBfdPeer(String name, PolicyStaticRouteBfdPeerArgs args, CustomResourceOptions options)

    type: nsxt:PolicyStaticRouteBfdPeer
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 PolicyStaticRouteBfdPeerArgs
    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 PolicyStaticRouteBfdPeerArgs
    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 PolicyStaticRouteBfdPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyStaticRouteBfdPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyStaticRouteBfdPeerArgs
    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 policyStaticRouteBfdPeerResource = new Nsxt.PolicyStaticRouteBfdPeer("policyStaticRouteBfdPeerResource", new()
{
    BfdProfilePath = "string",
    DisplayName = "string",
    GatewayPath = "string",
    PeerAddress = "string",
    Description = "string",
    Enabled = false,
    NsxId = "string",
    PolicyStaticRouteBfdPeerId = "string",
    SourceAddresses = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyStaticRouteBfdPeerTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyStaticRouteBfdPeer(ctx, "policyStaticRouteBfdPeerResource", &nsxt.PolicyStaticRouteBfdPeerArgs{
	BfdProfilePath:             pulumi.String("string"),
	DisplayName:                pulumi.String("string"),
	GatewayPath:                pulumi.String("string"),
	PeerAddress:                pulumi.String("string"),
	Description:                pulumi.String("string"),
	Enabled:                    pulumi.Bool(false),
	NsxId:                      pulumi.String("string"),
	PolicyStaticRouteBfdPeerId: pulumi.String("string"),
	SourceAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: nsxt.PolicyStaticRouteBfdPeerTagArray{
		&nsxt.PolicyStaticRouteBfdPeerTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyStaticRouteBfdPeerResource = new PolicyStaticRouteBfdPeer("policyStaticRouteBfdPeerResource", PolicyStaticRouteBfdPeerArgs.builder()
    .bfdProfilePath("string")
    .displayName("string")
    .gatewayPath("string")
    .peerAddress("string")
    .description("string")
    .enabled(false)
    .nsxId("string")
    .policyStaticRouteBfdPeerId("string")
    .sourceAddresses("string")
    .tags(PolicyStaticRouteBfdPeerTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_static_route_bfd_peer_resource = nsxt.PolicyStaticRouteBfdPeer("policyStaticRouteBfdPeerResource",
    bfd_profile_path="string",
    display_name="string",
    gateway_path="string",
    peer_address="string",
    description="string",
    enabled=False,
    nsx_id="string",
    policy_static_route_bfd_peer_id="string",
    source_addresses=["string"],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyStaticRouteBfdPeerResource = new nsxt.PolicyStaticRouteBfdPeer("policyStaticRouteBfdPeerResource", {
    bfdProfilePath: "string",
    displayName: "string",
    gatewayPath: "string",
    peerAddress: "string",
    description: "string",
    enabled: false,
    nsxId: "string",
    policyStaticRouteBfdPeerId: "string",
    sourceAddresses: ["string"],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyStaticRouteBfdPeer
properties:
    bfdProfilePath: string
    description: string
    displayName: string
    enabled: false
    gatewayPath: string
    nsxId: string
    peerAddress: string
    policyStaticRouteBfdPeerId: string
    sourceAddresses:
        - string
    tags:
        - scope: string
          tag: string

    PolicyStaticRouteBfdPeer 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 PolicyStaticRouteBfdPeer resource accepts the following input properties:

    BfdProfilePath string
    Policy path for BFD Profile
    DisplayName string
    Display name for this resource
    GatewayPath string
    Policy path for Tier0 gateway
    PeerAddress string
    IPv4 Address of the peer
    Description string
    Description for this resource
    Enabled bool
    Flag to enable/disable this peer
    NsxId string
    NSX ID for this resource
    PolicyStaticRouteBfdPeerId string
    SourceAddresses List<string>
    Array of Tier0 external interface IP addresses
    Tags List<PolicyStaticRouteBfdPeerTag>
    Set of opaque identifiers meaningful to the user
    BfdProfilePath string
    Policy path for BFD Profile
    DisplayName string
    Display name for this resource
    GatewayPath string
    Policy path for Tier0 gateway
    PeerAddress string
    IPv4 Address of the peer
    Description string
    Description for this resource
    Enabled bool
    Flag to enable/disable this peer
    NsxId string
    NSX ID for this resource
    PolicyStaticRouteBfdPeerId string
    SourceAddresses []string
    Array of Tier0 external interface IP addresses
    Tags []PolicyStaticRouteBfdPeerTagArgs
    Set of opaque identifiers meaningful to the user
    bfdProfilePath String
    Policy path for BFD Profile
    displayName String
    Display name for this resource
    gatewayPath String
    Policy path for Tier0 gateway
    peerAddress String
    IPv4 Address of the peer
    description String
    Description for this resource
    enabled Boolean
    Flag to enable/disable this peer
    nsxId String
    NSX ID for this resource
    policyStaticRouteBfdPeerId String
    sourceAddresses List<String>
    Array of Tier0 external interface IP addresses
    tags List<PolicyStaticRouteBfdPeerTag>
    Set of opaque identifiers meaningful to the user
    bfdProfilePath string
    Policy path for BFD Profile
    displayName string
    Display name for this resource
    gatewayPath string
    Policy path for Tier0 gateway
    peerAddress string
    IPv4 Address of the peer
    description string
    Description for this resource
    enabled boolean
    Flag to enable/disable this peer
    nsxId string
    NSX ID for this resource
    policyStaticRouteBfdPeerId string
    sourceAddresses string[]
    Array of Tier0 external interface IP addresses
    tags PolicyStaticRouteBfdPeerTag[]
    Set of opaque identifiers meaningful to the user
    bfd_profile_path str
    Policy path for BFD Profile
    display_name str
    Display name for this resource
    gateway_path str
    Policy path for Tier0 gateway
    peer_address str
    IPv4 Address of the peer
    description str
    Description for this resource
    enabled bool
    Flag to enable/disable this peer
    nsx_id str
    NSX ID for this resource
    policy_static_route_bfd_peer_id str
    source_addresses Sequence[str]
    Array of Tier0 external interface IP addresses
    tags Sequence[PolicyStaticRouteBfdPeerTagArgs]
    Set of opaque identifiers meaningful to the user
    bfdProfilePath String
    Policy path for BFD Profile
    displayName String
    Display name for this resource
    gatewayPath String
    Policy path for Tier0 gateway
    peerAddress String
    IPv4 Address of the peer
    description String
    Description for this resource
    enabled Boolean
    Flag to enable/disable this peer
    nsxId String
    NSX ID for this resource
    policyStaticRouteBfdPeerId String
    sourceAddresses List<String>
    Array of Tier0 external interface IP addresses
    tags List<Property Map>
    Set of opaque identifiers meaningful to the user

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyStaticRouteBfdPeer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    Policy path for this resource
    Revision double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    Policy path for this resource
    Revision float64
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    Policy path for this resource
    revision Double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    Policy path for this resource
    revision number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    Policy path for this resource
    revision float
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    Policy path for this resource
    revision Number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected

    Look up Existing PolicyStaticRouteBfdPeer Resource

    Get an existing PolicyStaticRouteBfdPeer 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?: PolicyStaticRouteBfdPeerState, opts?: CustomResourceOptions): PolicyStaticRouteBfdPeer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bfd_profile_path: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        gateway_path: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        peer_address: Optional[str] = None,
        policy_static_route_bfd_peer_id: Optional[str] = None,
        revision: Optional[float] = None,
        source_addresses: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyStaticRouteBfdPeerTagArgs]] = None) -> PolicyStaticRouteBfdPeer
    func GetPolicyStaticRouteBfdPeer(ctx *Context, name string, id IDInput, state *PolicyStaticRouteBfdPeerState, opts ...ResourceOption) (*PolicyStaticRouteBfdPeer, error)
    public static PolicyStaticRouteBfdPeer Get(string name, Input<string> id, PolicyStaticRouteBfdPeerState? state, CustomResourceOptions? opts = null)
    public static PolicyStaticRouteBfdPeer get(String name, Output<String> id, PolicyStaticRouteBfdPeerState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyStaticRouteBfdPeer    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.
    The following state arguments are supported:
    BfdProfilePath string
    Policy path for BFD Profile
    Description string
    Description for this resource
    DisplayName string
    Display name for this resource
    Enabled bool
    Flag to enable/disable this peer
    GatewayPath string
    Policy path for Tier0 gateway
    NsxId string
    NSX ID for this resource
    Path string
    Policy path for this resource
    PeerAddress string
    IPv4 Address of the peer
    PolicyStaticRouteBfdPeerId string
    Revision double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    SourceAddresses List<string>
    Array of Tier0 external interface IP addresses
    Tags List<PolicyStaticRouteBfdPeerTag>
    Set of opaque identifiers meaningful to the user
    BfdProfilePath string
    Policy path for BFD Profile
    Description string
    Description for this resource
    DisplayName string
    Display name for this resource
    Enabled bool
    Flag to enable/disable this peer
    GatewayPath string
    Policy path for Tier0 gateway
    NsxId string
    NSX ID for this resource
    Path string
    Policy path for this resource
    PeerAddress string
    IPv4 Address of the peer
    PolicyStaticRouteBfdPeerId string
    Revision float64
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    SourceAddresses []string
    Array of Tier0 external interface IP addresses
    Tags []PolicyStaticRouteBfdPeerTagArgs
    Set of opaque identifiers meaningful to the user
    bfdProfilePath String
    Policy path for BFD Profile
    description String
    Description for this resource
    displayName String
    Display name for this resource
    enabled Boolean
    Flag to enable/disable this peer
    gatewayPath String
    Policy path for Tier0 gateway
    nsxId String
    NSX ID for this resource
    path String
    Policy path for this resource
    peerAddress String
    IPv4 Address of the peer
    policyStaticRouteBfdPeerId String
    revision Double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    sourceAddresses List<String>
    Array of Tier0 external interface IP addresses
    tags List<PolicyStaticRouteBfdPeerTag>
    Set of opaque identifiers meaningful to the user
    bfdProfilePath string
    Policy path for BFD Profile
    description string
    Description for this resource
    displayName string
    Display name for this resource
    enabled boolean
    Flag to enable/disable this peer
    gatewayPath string
    Policy path for Tier0 gateway
    nsxId string
    NSX ID for this resource
    path string
    Policy path for this resource
    peerAddress string
    IPv4 Address of the peer
    policyStaticRouteBfdPeerId string
    revision number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    sourceAddresses string[]
    Array of Tier0 external interface IP addresses
    tags PolicyStaticRouteBfdPeerTag[]
    Set of opaque identifiers meaningful to the user
    bfd_profile_path str
    Policy path for BFD Profile
    description str
    Description for this resource
    display_name str
    Display name for this resource
    enabled bool
    Flag to enable/disable this peer
    gateway_path str
    Policy path for Tier0 gateway
    nsx_id str
    NSX ID for this resource
    path str
    Policy path for this resource
    peer_address str
    IPv4 Address of the peer
    policy_static_route_bfd_peer_id str
    revision float
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    source_addresses Sequence[str]
    Array of Tier0 external interface IP addresses
    tags Sequence[PolicyStaticRouteBfdPeerTagArgs]
    Set of opaque identifiers meaningful to the user
    bfdProfilePath String
    Policy path for BFD Profile
    description String
    Description for this resource
    displayName String
    Display name for this resource
    enabled Boolean
    Flag to enable/disable this peer
    gatewayPath String
    Policy path for Tier0 gateway
    nsxId String
    NSX ID for this resource
    path String
    Policy path for this resource
    peerAddress String
    IPv4 Address of the peer
    policyStaticRouteBfdPeerId String
    revision Number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    sourceAddresses List<String>
    Array of Tier0 external interface IP addresses
    tags List<Property Map>
    Set of opaque identifiers meaningful to the user

    Supporting Types

    PolicyStaticRouteBfdPeerTag, PolicyStaticRouteBfdPeerTagArgs

    Scope string
    Tag string
    Scope string
    Tag string
    scope String
    tag String
    scope string
    tag string
    scope str
    tag str
    scope String
    tag String

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt