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

nsxt.PolicySite

Explore with Pulumi AI

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

    Create PolicySite Resource

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

    Constructor syntax

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

@overload
def PolicySite(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               site_type: Optional[str] = None,
               description: Optional[str] = None,
               fail_if_rtep_misconfigured: Optional[bool] = None,
               fail_if_rtt_exceeded: Optional[bool] = None,
               maximum_rtt: Optional[float] = None,
               nsx_id: Optional[str] = None,
               policy_site_id: Optional[str] = None,
               site_connection_infos: Optional[Sequence[PolicySiteSiteConnectionInfoArgs]] = None,
               tags: Optional[Sequence[PolicySiteTagArgs]] = None)
    func NewPolicySite(ctx *Context, name string, args PolicySiteArgs, opts ...ResourceOption) (*PolicySite, error)
    public PolicySite(string name, PolicySiteArgs args, CustomResourceOptions? opts = null)
    public PolicySite(String name, PolicySiteArgs args)
public PolicySite(String name, PolicySiteArgs args, CustomResourceOptions options)

    type: nsxt:PolicySite
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 PolicySiteArgs
    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 PolicySiteArgs
    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 PolicySiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicySiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicySiteArgs
    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 policySiteResource = new Nsxt.PolicySite("policySiteResource", new()
{
    DisplayName = "string",
    SiteType = "string",
    Description = "string",
    FailIfRtepMisconfigured = false,
    FailIfRttExceeded = false,
    MaximumRtt = 0,
    NsxId = "string",
    PolicySiteId = "string",
    SiteConnectionInfos = new[]
    {
        new Nsxt.Inputs.PolicySiteSiteConnectionInfoArgs
        {
            Fqdn = "string",
            Password = "string",
            SiteUuid = "string",
            Thumbprint = "string",
            Username = "string",
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicySiteTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicySite(ctx, "policySiteResource", &nsxt.PolicySiteArgs{
	DisplayName:             pulumi.String("string"),
	SiteType:                pulumi.String("string"),
	Description:             pulumi.String("string"),
	FailIfRtepMisconfigured: pulumi.Bool(false),
	FailIfRttExceeded:       pulumi.Bool(false),
	MaximumRtt:              pulumi.Float64(0),
	NsxId:                   pulumi.String("string"),
	PolicySiteId:            pulumi.String("string"),
	SiteConnectionInfos: nsxt.PolicySiteSiteConnectionInfoArray{
		&nsxt.PolicySiteSiteConnectionInfoArgs{
			Fqdn:       pulumi.String("string"),
			Password:   pulumi.String("string"),
			SiteUuid:   pulumi.String("string"),
			Thumbprint: pulumi.String("string"),
			Username:   pulumi.String("string"),
		},
	},
	Tags: nsxt.PolicySiteTagArray{
		&nsxt.PolicySiteTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policySiteResource = new PolicySite("policySiteResource", PolicySiteArgs.builder()
    .displayName("string")
    .siteType("string")
    .description("string")
    .failIfRtepMisconfigured(false)
    .failIfRttExceeded(false)
    .maximumRtt(0)
    .nsxId("string")
    .policySiteId("string")
    .siteConnectionInfos(PolicySiteSiteConnectionInfoArgs.builder()
        .fqdn("string")
        .password("string")
        .siteUuid("string")
        .thumbprint("string")
        .username("string")
        .build())
    .tags(PolicySiteTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_site_resource = nsxt.PolicySite("policySiteResource",
    display_name="string",
    site_type="string",
    description="string",
    fail_if_rtep_misconfigured=False,
    fail_if_rtt_exceeded=False,
    maximum_rtt=0,
    nsx_id="string",
    policy_site_id="string",
    site_connection_infos=[{
        "fqdn": "string",
        "password": "string",
        "site_uuid": "string",
        "thumbprint": "string",
        "username": "string",
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policySiteResource = new nsxt.PolicySite("policySiteResource", {
    displayName: "string",
    siteType: "string",
    description: "string",
    failIfRtepMisconfigured: false,
    failIfRttExceeded: false,
    maximumRtt: 0,
    nsxId: "string",
    policySiteId: "string",
    siteConnectionInfos: [{
        fqdn: "string",
        password: "string",
        siteUuid: "string",
        thumbprint: "string",
        username: "string",
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicySite
properties:
    description: string
    displayName: string
    failIfRtepMisconfigured: false
    failIfRttExceeded: false
    maximumRtt: 0
    nsxId: string
    policySiteId: string
    siteConnectionInfos:
        - fqdn: string
          password: string
          siteUuid: string
          thumbprint: string
          username: string
    siteType: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    SiteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    Description string
    Description of the resource.
    FailIfRtepMisconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicySiteId string
    ID of the resource.
    SiteConnectionInfos List<PolicySiteSiteConnectionInfo>
    Connection information.
    Tags List<PolicySiteTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    SiteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    Description string
    Description of the resource.
    FailIfRtepMisconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt float64
    Maximum acceptable packet round trip time (RTT). Default is 250.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicySiteId string
    ID of the resource.
    SiteConnectionInfos []PolicySiteSiteConnectionInfoArgs
    Connection information.
    Tags []PolicySiteTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    siteType String
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    description String
    Description of the resource.
    failIfRtepMisconfigured Boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySiteId String
    ID of the resource.
    siteConnectionInfos List<PolicySiteSiteConnectionInfo>
    Connection information.
    tags List<PolicySiteTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    siteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    description string
    Description of the resource.
    failIfRtepMisconfigured boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySiteId string
    ID of the resource.
    siteConnectionInfos PolicySiteSiteConnectionInfo[]
    Connection information.
    tags PolicySiteTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    site_type str
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    description str
    Description of the resource.
    fail_if_rtep_misconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    fail_if_rtt_exceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximum_rtt float
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_site_id str
    ID of the resource.
    site_connection_infos Sequence[PolicySiteSiteConnectionInfoArgs]
    Connection information.
    tags Sequence[PolicySiteTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    siteType String
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    description String
    Description of the resource.
    failIfRtepMisconfigured Boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySiteId String
    ID of the resource.
    siteConnectionInfos List<Property Map>
    Connection information.
    tags 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 PolicySite resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicySite Resource

    Get an existing PolicySite 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?: PolicySiteState, opts?: CustomResourceOptions): PolicySite
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        fail_if_rtep_misconfigured: Optional[bool] = None,
        fail_if_rtt_exceeded: Optional[bool] = None,
        maximum_rtt: Optional[float] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_site_id: Optional[str] = None,
        revision: Optional[float] = None,
        site_connection_infos: Optional[Sequence[PolicySiteSiteConnectionInfoArgs]] = None,
        site_type: Optional[str] = None,
        tags: Optional[Sequence[PolicySiteTagArgs]] = None) -> PolicySite
    func GetPolicySite(ctx *Context, name string, id IDInput, state *PolicySiteState, opts ...ResourceOption) (*PolicySite, error)
    public static PolicySite Get(string name, Input<string> id, PolicySiteState? state, CustomResourceOptions? opts = null)
    public static PolicySite get(String name, Output<String> id, PolicySiteState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicySite    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:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FailIfRtepMisconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    NsxId 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.
    PolicySiteId string
    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.
    SiteConnectionInfos List<PolicySiteSiteConnectionInfo>
    Connection information.
    SiteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    Tags List<PolicySiteTag>
    A list of scope + tag pairs to associate with this resource.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FailIfRtepMisconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt float64
    Maximum acceptable packet round trip time (RTT). Default is 250.
    NsxId 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.
    PolicySiteId string
    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.
    SiteConnectionInfos []PolicySiteSiteConnectionInfoArgs
    Connection information.
    SiteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    Tags []PolicySiteTagArgs
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failIfRtepMisconfigured Boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId 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.
    policySiteId String
    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.
    siteConnectionInfos List<PolicySiteSiteConnectionInfo>
    Connection information.
    siteType String
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    tags List<PolicySiteTag>
    A list of scope + tag pairs to associate with this resource.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    failIfRtepMisconfigured boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId 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.
    policySiteId string
    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.
    siteConnectionInfos PolicySiteSiteConnectionInfo[]
    Connection information.
    siteType string
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    tags PolicySiteTag[]
    A list of scope + tag pairs to associate with this resource.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    fail_if_rtep_misconfigured bool
    Fail onboarding if RTEPs misconfigured. Default is true.
    fail_if_rtt_exceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximum_rtt float
    Maximum acceptable packet round trip time (RTT). Default is 250.
    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_site_id str
    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_connection_infos Sequence[PolicySiteSiteConnectionInfoArgs]
    Connection information.
    site_type str
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    tags Sequence[PolicySiteTagArgs]
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failIfRtepMisconfigured Boolean
    Fail onboarding if RTEPs misconfigured. Default is true.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    nsxId 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.
    policySiteId String
    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.
    siteConnectionInfos List<Property Map>
    Connection information.
    siteType String
    Persistent Site Type. Allowed values are ONPREM_LM, SDDC_LM. This attribute is supported with NSX 4.1.0 onwards.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicySiteSiteConnectionInfo, PolicySiteSiteConnectionInfoArgs

    Fqdn string
    Fully Qualified Domain Name of the Management Node.
    Password string
    Password.
    SiteUuid string
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    Thumbprint string
    Thumbprint of Enforcement Point.
    Username string
    Username.
    Fqdn string
    Fully Qualified Domain Name of the Management Node.
    Password string
    Password.
    SiteUuid string
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    Thumbprint string
    Thumbprint of Enforcement Point.
    Username string
    Username.
    fqdn String
    Fully Qualified Domain Name of the Management Node.
    password String
    Password.
    siteUuid String
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    thumbprint String
    Thumbprint of Enforcement Point.
    username String
    Username.
    fqdn string
    Fully Qualified Domain Name of the Management Node.
    password string
    Password.
    siteUuid string
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    thumbprint string
    Thumbprint of Enforcement Point.
    username string
    Username.
    fqdn str
    Fully Qualified Domain Name of the Management Node.
    password str
    Password.
    site_uuid str
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    thumbprint str
    Thumbprint of Enforcement Point.
    username str
    Username.
    fqdn String
    Fully Qualified Domain Name of the Management Node.
    password String
    Password.
    siteUuid String
    ID of Site. This attribute is supported with NSX 4.1.0 onwards.
    thumbprint String
    Thumbprint of Enforcement Point.
    username String
    Username.

    PolicySiteTag, PolicySiteTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    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