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

nsxt.PolicyGlobalManager

Explore with Pulumi AI

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

    Create PolicyGlobalManager Resource

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

    Constructor syntax

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

@overload
def PolicyGlobalManager(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        display_name: Optional[str] = None,
                        mode: Optional[str] = None,
                        connection_infos: Optional[Sequence[PolicyGlobalManagerConnectionInfoArgs]] = None,
                        description: Optional[str] = None,
                        fail_if_rtt_exceeded: Optional[bool] = None,
                        maximum_rtt: Optional[float] = None,
                        nsx_id: Optional[str] = None,
                        policy_global_manager_id: Optional[str] = None,
                        tags: Optional[Sequence[PolicyGlobalManagerTagArgs]] = None)
    func NewPolicyGlobalManager(ctx *Context, name string, args PolicyGlobalManagerArgs, opts ...ResourceOption) (*PolicyGlobalManager, error)
    public PolicyGlobalManager(string name, PolicyGlobalManagerArgs args, CustomResourceOptions? opts = null)
    public PolicyGlobalManager(String name, PolicyGlobalManagerArgs args)
public PolicyGlobalManager(String name, PolicyGlobalManagerArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGlobalManager
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 PolicyGlobalManagerArgs
    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 PolicyGlobalManagerArgs
    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 PolicyGlobalManagerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGlobalManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGlobalManagerArgs
    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 policyGlobalManagerResource = new Nsxt.PolicyGlobalManager("policyGlobalManagerResource", new()
{
    DisplayName = "string",
    Mode = "string",
    ConnectionInfos = new[]
    {
        new Nsxt.Inputs.PolicyGlobalManagerConnectionInfoArgs
        {
            Fqdn = "string",
            Password = "string",
            SiteUuid = "string",
            Thumbprint = "string",
            Username = "string",
        },
    },
    Description = "string",
    FailIfRttExceeded = false,
    MaximumRtt = 0,
    NsxId = "string",
    PolicyGlobalManagerId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyGlobalManagerTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyGlobalManager(ctx, "policyGlobalManagerResource", &nsxt.PolicyGlobalManagerArgs{
	DisplayName: pulumi.String("string"),
	Mode:        pulumi.String("string"),
	ConnectionInfos: nsxt.PolicyGlobalManagerConnectionInfoArray{
		&nsxt.PolicyGlobalManagerConnectionInfoArgs{
			Fqdn:       pulumi.String("string"),
			Password:   pulumi.String("string"),
			SiteUuid:   pulumi.String("string"),
			Thumbprint: pulumi.String("string"),
			Username:   pulumi.String("string"),
		},
	},
	Description:           pulumi.String("string"),
	FailIfRttExceeded:     pulumi.Bool(false),
	MaximumRtt:            pulumi.Float64(0),
	NsxId:                 pulumi.String("string"),
	PolicyGlobalManagerId: pulumi.String("string"),
	Tags: nsxt.PolicyGlobalManagerTagArray{
		&nsxt.PolicyGlobalManagerTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyGlobalManagerResource = new PolicyGlobalManager("policyGlobalManagerResource", PolicyGlobalManagerArgs.builder()
    .displayName("string")
    .mode("string")
    .connectionInfos(PolicyGlobalManagerConnectionInfoArgs.builder()
        .fqdn("string")
        .password("string")
        .siteUuid("string")
        .thumbprint("string")
        .username("string")
        .build())
    .description("string")
    .failIfRttExceeded(false)
    .maximumRtt(0)
    .nsxId("string")
    .policyGlobalManagerId("string")
    .tags(PolicyGlobalManagerTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_global_manager_resource = nsxt.PolicyGlobalManager("policyGlobalManagerResource",
    display_name="string",
    mode="string",
    connection_infos=[{
        "fqdn": "string",
        "password": "string",
        "site_uuid": "string",
        "thumbprint": "string",
        "username": "string",
    }],
    description="string",
    fail_if_rtt_exceeded=False,
    maximum_rtt=0,
    nsx_id="string",
    policy_global_manager_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyGlobalManagerResource = new nsxt.PolicyGlobalManager("policyGlobalManagerResource", {
    displayName: "string",
    mode: "string",
    connectionInfos: [{
        fqdn: "string",
        password: "string",
        siteUuid: "string",
        thumbprint: "string",
        username: "string",
    }],
    description: "string",
    failIfRttExceeded: false,
    maximumRtt: 0,
    nsxId: "string",
    policyGlobalManagerId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyGlobalManager
properties:
    connectionInfos:
        - fqdn: string
          password: string
          siteUuid: string
          thumbprint: string
          username: string
    description: string
    displayName: string
    failIfRttExceeded: false
    maximumRtt: 0
    mode: string
    nsxId: string
    policyGlobalManagerId: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    Mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    ConnectionInfos List<PolicyGlobalManagerConnectionInfo>
    Connection information.
    Description string
    Description of the resource.
    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.
    PolicyGlobalManagerId string
    ID of the resource.
    Tags List<PolicyGlobalManagerTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    Mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    ConnectionInfos []PolicyGlobalManagerConnectionInfoArgs
    Connection information.
    Description string
    Description of the resource.
    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.
    PolicyGlobalManagerId string
    ID of the resource.
    Tags []PolicyGlobalManagerTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    mode String
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    connectionInfos List<PolicyGlobalManagerConnectionInfo>
    Connection information.
    description String
    Description of the resource.
    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.
    policyGlobalManagerId String
    ID of the resource.
    tags List<PolicyGlobalManagerTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    connectionInfos PolicyGlobalManagerConnectionInfo[]
    Connection information.
    description string
    Description of the resource.
    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.
    policyGlobalManagerId string
    ID of the resource.
    tags PolicyGlobalManagerTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    mode str
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    connection_infos Sequence[PolicyGlobalManagerConnectionInfoArgs]
    Connection information.
    description str
    Description of the resource.
    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_global_manager_id str
    ID of the resource.
    tags Sequence[PolicyGlobalManagerTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    mode String
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    connectionInfos List<Property Map>
    Connection information.
    description String
    Description of the resource.
    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.
    policyGlobalManagerId String
    ID of the resource.
    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 PolicyGlobalManager 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 PolicyGlobalManager Resource

    Get an existing PolicyGlobalManager 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?: PolicyGlobalManagerState, opts?: CustomResourceOptions): PolicyGlobalManager
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_infos: Optional[Sequence[PolicyGlobalManagerConnectionInfoArgs]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        fail_if_rtt_exceeded: Optional[bool] = None,
        maximum_rtt: Optional[float] = None,
        mode: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_global_manager_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyGlobalManagerTagArgs]] = None) -> PolicyGlobalManager
    func GetPolicyGlobalManager(ctx *Context, name string, id IDInput, state *PolicyGlobalManagerState, opts ...ResourceOption) (*PolicyGlobalManager, error)
    public static PolicyGlobalManager Get(string name, Input<string> id, PolicyGlobalManagerState? state, CustomResourceOptions? opts = null)
    public static PolicyGlobalManager get(String name, Output<String> id, PolicyGlobalManagerState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGlobalManager    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:
    ConnectionInfos List<PolicyGlobalManagerConnectionInfo>
    Connection information.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    Mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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.
    PolicyGlobalManagerId 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.
    Tags List<PolicyGlobalManagerTag>
    A list of scope + tag pairs to associate with this resource.
    ConnectionInfos []PolicyGlobalManagerConnectionInfoArgs
    Connection information.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FailIfRttExceeded bool
    Fail onboarding if maximum RTT exceeded. Default is true.
    MaximumRtt float64
    Maximum acceptable packet round trip time (RTT). Default is 250.
    Mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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.
    PolicyGlobalManagerId 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.
    Tags []PolicyGlobalManagerTagArgs
    A list of scope + tag pairs to associate with this resource.
    connectionInfos List<PolicyGlobalManagerConnectionInfo>
    Connection information.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Double
    Maximum acceptable packet round trip time (RTT). Default is 250.
    mode String
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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.
    policyGlobalManagerId 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.
    tags List<PolicyGlobalManagerTag>
    A list of scope + tag pairs to associate with this resource.
    connectionInfos PolicyGlobalManagerConnectionInfo[]
    Connection information.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    failIfRttExceeded boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    mode string
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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.
    policyGlobalManagerId 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.
    tags PolicyGlobalManagerTag[]
    A list of scope + tag pairs to associate with this resource.
    connection_infos Sequence[PolicyGlobalManagerConnectionInfoArgs]
    Connection information.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    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.
    mode str
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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_global_manager_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.
    tags Sequence[PolicyGlobalManagerTagArgs]
    A list of scope + tag pairs to associate with this resource.
    connectionInfos List<Property Map>
    Connection information.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failIfRttExceeded Boolean
    Fail onboarding if maximum RTT exceeded. Default is true.
    maximumRtt Number
    Maximum acceptable packet round trip time (RTT). Default is 250.
    mode String
    Mode of the global manager. Allowed values are ACTIVE, STANDBY.
    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.
    policyGlobalManagerId 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.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyGlobalManagerConnectionInfo, PolicyGlobalManagerConnectionInfoArgs

    Fqdn string
    Fully Qualified Domain Name of the Management Node.
    Password string
    Password.
    SiteUuid string
    ID of Global Manager.
    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 Global Manager.
    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 Global Manager.
    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 Global Manager.
    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 Global Manager.
    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 Global Manager.
    thumbprint String
    Thumbprint of Enforcement Point.
    username String
    Username.

    PolicyGlobalManagerTag, PolicyGlobalManagerTagArgs

    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