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

nsxt.PolicyOspfArea

Explore with Pulumi AI

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

    Create PolicyOspfArea Resource

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

    Constructor syntax

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

@overload
def PolicyOspfArea(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   area_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   ospf_path: Optional[str] = None,
                   area_type: Optional[str] = None,
                   auth_mode: Optional[str] = None,
                   description: Optional[str] = None,
                   key_id: Optional[float] = None,
                   nsx_id: Optional[str] = None,
                   policy_ospf_area_id: Optional[str] = None,
                   secret_key: Optional[str] = None,
                   tags: Optional[Sequence[PolicyOspfAreaTagArgs]] = None)
    func NewPolicyOspfArea(ctx *Context, name string, args PolicyOspfAreaArgs, opts ...ResourceOption) (*PolicyOspfArea, error)
    public PolicyOspfArea(string name, PolicyOspfAreaArgs args, CustomResourceOptions? opts = null)
    public PolicyOspfArea(String name, PolicyOspfAreaArgs args)
public PolicyOspfArea(String name, PolicyOspfAreaArgs args, CustomResourceOptions options)

    type: nsxt:PolicyOspfArea
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 PolicyOspfAreaArgs
    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 PolicyOspfAreaArgs
    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 PolicyOspfAreaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyOspfAreaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyOspfAreaArgs
    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 policyOspfAreaResource = new Nsxt.PolicyOspfArea("policyOspfAreaResource", new()
{
    AreaId = "string",
    DisplayName = "string",
    OspfPath = "string",
    AreaType = "string",
    AuthMode = "string",
    Description = "string",
    KeyId = 0,
    NsxId = "string",
    PolicyOspfAreaId = "string",
    SecretKey = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyOspfAreaTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyOspfArea(ctx, "policyOspfAreaResource", &nsxt.PolicyOspfAreaArgs{
	AreaId:           pulumi.String("string"),
	DisplayName:      pulumi.String("string"),
	OspfPath:         pulumi.String("string"),
	AreaType:         pulumi.String("string"),
	AuthMode:         pulumi.String("string"),
	Description:      pulumi.String("string"),
	KeyId:            pulumi.Float64(0),
	NsxId:            pulumi.String("string"),
	PolicyOspfAreaId: pulumi.String("string"),
	SecretKey:        pulumi.String("string"),
	Tags: nsxt.PolicyOspfAreaTagArray{
		&nsxt.PolicyOspfAreaTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyOspfAreaResource = new PolicyOspfArea("policyOspfAreaResource", PolicyOspfAreaArgs.builder()
    .areaId("string")
    .displayName("string")
    .ospfPath("string")
    .areaType("string")
    .authMode("string")
    .description("string")
    .keyId(0)
    .nsxId("string")
    .policyOspfAreaId("string")
    .secretKey("string")
    .tags(PolicyOspfAreaTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_ospf_area_resource = nsxt.PolicyOspfArea("policyOspfAreaResource",
    area_id="string",
    display_name="string",
    ospf_path="string",
    area_type="string",
    auth_mode="string",
    description="string",
    key_id=0,
    nsx_id="string",
    policy_ospf_area_id="string",
    secret_key="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyOspfAreaResource = new nsxt.PolicyOspfArea("policyOspfAreaResource", {
    areaId: "string",
    displayName: "string",
    ospfPath: "string",
    areaType: "string",
    authMode: "string",
    description: "string",
    keyId: 0,
    nsxId: "string",
    policyOspfAreaId: "string",
    secretKey: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyOspfArea
properties:
    areaId: string
    areaType: string
    authMode: string
    description: string
    displayName: string
    keyId: 0
    nsxId: string
    ospfPath: string
    policyOspfAreaId: string
    secretKey: string
    tags:
        - scope: string
          tag: string

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

    AreaId string
    OSPF area ID in decimal or dotted format
    DisplayName string
    Display name of the resource.
    OspfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    AreaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    AuthMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    Description string
    Description of the resource.
    KeyId double
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyOspfAreaId string
    ID of the resource.
    SecretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    Tags List<PolicyOspfAreaTag>
    A list of scope + tag pairs to associate with this resource.
    AreaId string
    OSPF area ID in decimal or dotted format
    DisplayName string
    Display name of the resource.
    OspfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    AreaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    AuthMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    Description string
    Description of the resource.
    KeyId float64
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyOspfAreaId string
    ID of the resource.
    SecretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    Tags []PolicyOspfAreaTagArgs
    A list of scope + tag pairs to associate with this resource.
    areaId String
    OSPF area ID in decimal or dotted format
    displayName String
    Display name of the resource.
    ospfPath String
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    areaType String
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode String
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description String
    Description of the resource.
    keyId Double
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyOspfAreaId String
    ID of the resource.
    secretKey String
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags List<PolicyOspfAreaTag>
    A list of scope + tag pairs to associate with this resource.
    areaId string
    OSPF area ID in decimal or dotted format
    displayName string
    Display name of the resource.
    ospfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    areaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description string
    Description of the resource.
    keyId number
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyOspfAreaId string
    ID of the resource.
    secretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags PolicyOspfAreaTag[]
    A list of scope + tag pairs to associate with this resource.
    area_id str
    OSPF area ID in decimal or dotted format
    display_name str
    Display name of the resource.
    ospf_path str
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    area_type str
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    auth_mode str
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description str
    Description of the resource.
    key_id float
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_ospf_area_id str
    ID of the resource.
    secret_key str
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags Sequence[PolicyOspfAreaTagArgs]
    A list of scope + tag pairs to associate with this resource.
    areaId String
    OSPF area ID in decimal or dotted format
    displayName String
    Display name of the resource.
    ospfPath String
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    areaType String
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode String
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description String
    Description of the resource.
    keyId Number
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyOspfAreaId String
    ID of the resource.
    secretKey String
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    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 PolicyOspfArea 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 PolicyOspfArea Resource

    Get an existing PolicyOspfArea 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?: PolicyOspfAreaState, opts?: CustomResourceOptions): PolicyOspfArea
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        area_id: Optional[str] = None,
        area_type: Optional[str] = None,
        auth_mode: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        key_id: Optional[float] = None,
        nsx_id: Optional[str] = None,
        ospf_path: Optional[str] = None,
        path: Optional[str] = None,
        policy_ospf_area_id: Optional[str] = None,
        revision: Optional[float] = None,
        secret_key: Optional[str] = None,
        tags: Optional[Sequence[PolicyOspfAreaTagArgs]] = None) -> PolicyOspfArea
    func GetPolicyOspfArea(ctx *Context, name string, id IDInput, state *PolicyOspfAreaState, opts ...ResourceOption) (*PolicyOspfArea, error)
    public static PolicyOspfArea Get(string name, Input<string> id, PolicyOspfAreaState? state, CustomResourceOptions? opts = null)
    public static PolicyOspfArea get(String name, Output<String> id, PolicyOspfAreaState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyOspfArea    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:
    AreaId string
    OSPF area ID in decimal or dotted format
    AreaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    AuthMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    KeyId double
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    OspfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    Path string
    The NSX path of the policy resource.
    PolicyOspfAreaId 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.
    SecretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    Tags List<PolicyOspfAreaTag>
    A list of scope + tag pairs to associate with this resource.
    AreaId string
    OSPF area ID in decimal or dotted format
    AreaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    AuthMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    KeyId float64
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    OspfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    Path string
    The NSX path of the policy resource.
    PolicyOspfAreaId 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.
    SecretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    Tags []PolicyOspfAreaTagArgs
    A list of scope + tag pairs to associate with this resource.
    areaId String
    OSPF area ID in decimal or dotted format
    areaType String
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode String
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    keyId Double
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ospfPath String
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    path String
    The NSX path of the policy resource.
    policyOspfAreaId 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.
    secretKey String
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags List<PolicyOspfAreaTag>
    A list of scope + tag pairs to associate with this resource.
    areaId string
    OSPF area ID in decimal or dotted format
    areaType string
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode string
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    keyId number
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ospfPath string
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    path string
    The NSX path of the policy resource.
    policyOspfAreaId 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.
    secretKey string
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags PolicyOspfAreaTag[]
    A list of scope + tag pairs to associate with this resource.
    area_id str
    OSPF area ID in decimal or dotted format
    area_type str
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    auth_mode str
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    key_id float
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ospf_path str
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    path str
    The NSX path of the policy resource.
    policy_ospf_area_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.
    secret_key str
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags Sequence[PolicyOspfAreaTagArgs]
    A list of scope + tag pairs to associate with this resource.
    areaId String
    OSPF area ID in decimal or dotted format
    areaType String
    OSPF Area type, one of NORMAL or NSSA. Default is NSSA.
    authMode String
    OSPF Authentication mode, one of NONE, PASSWORD or MD5. By default, OSPF authentication is disabled with mode NONE.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    keyId Number
    Authentication secret key id, required for authenication mode MD5. This attribute is sensitive.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ospfPath String
    The policy path to the OSPF configuration on particular Tier-0 Gateway.

    • `area_id - (Required) OSPF Area ID in either decimal or dotted format.
    path String
    The NSX path of the policy resource.
    policyOspfAreaId 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.
    secretKey String
    Authentication secret key, required for authentication mode other than NONE. This attribute is sensitive. Length should not exceed 8 characters.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyOspfAreaTag, PolicyOspfAreaTagArgs

    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