1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtIpSet
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.NsxtIpSet

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create NsxtIpSet Resource

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

    Constructor syntax

    new NsxtIpSet(name: string, args: NsxtIpSetArgs, opts?: CustomResourceOptions);
    @overload
    def NsxtIpSet(resource_name: str,
                  args: NsxtIpSetArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def NsxtIpSet(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  edge_gateway_id: Optional[str] = None,
                  description: Optional[str] = None,
                  ip_addresses: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  nsxt_ip_set_id: Optional[str] = None,
                  org: Optional[str] = None,
                  vdc: Optional[str] = None)
    func NewNsxtIpSet(ctx *Context, name string, args NsxtIpSetArgs, opts ...ResourceOption) (*NsxtIpSet, error)
    public NsxtIpSet(string name, NsxtIpSetArgs args, CustomResourceOptions? opts = null)
    public NsxtIpSet(String name, NsxtIpSetArgs args)
    public NsxtIpSet(String name, NsxtIpSetArgs args, CustomResourceOptions options)
    
    type: vcd:NsxtIpSet
    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 NsxtIpSetArgs
    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 NsxtIpSetArgs
    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 NsxtIpSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtIpSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtIpSetArgs
    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 nsxtIpSetResource = new Vcd.NsxtIpSet("nsxtIpSetResource", new()
    {
        EdgeGatewayId = "string",
        Description = "string",
        IpAddresses = new[]
        {
            "string",
        },
        Name = "string",
        NsxtIpSetId = "string",
        Org = "string",
    });
    
    example, err := vcd.NewNsxtIpSet(ctx, "nsxtIpSetResource", &vcd.NsxtIpSetArgs{
    	EdgeGatewayId: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	IpAddresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:        pulumi.String("string"),
    	NsxtIpSetId: pulumi.String("string"),
    	Org:         pulumi.String("string"),
    })
    
    var nsxtIpSetResource = new NsxtIpSet("nsxtIpSetResource", NsxtIpSetArgs.builder()
        .edgeGatewayId("string")
        .description("string")
        .ipAddresses("string")
        .name("string")
        .nsxtIpSetId("string")
        .org("string")
        .build());
    
    nsxt_ip_set_resource = vcd.NsxtIpSet("nsxtIpSetResource",
        edge_gateway_id="string",
        description="string",
        ip_addresses=["string"],
        name="string",
        nsxt_ip_set_id="string",
        org="string")
    
    const nsxtIpSetResource = new vcd.NsxtIpSet("nsxtIpSetResource", {
        edgeGatewayId: "string",
        description: "string",
        ipAddresses: ["string"],
        name: "string",
        nsxtIpSetId: "string",
        org: "string",
    });
    
    type: vcd:NsxtIpSet
    properties:
        description: string
        edgeGatewayId: string
        ipAddresses:
            - string
        name: string
        nsxtIpSetId: string
        org: string
    

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

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    Description string
    An optional description of the IP Set
    IpAddresses List<string>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    Name string
    A unique name for IP Set
    NsxtIpSetId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    Description string
    An optional description of the IP Set
    IpAddresses []string
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    Name string
    A unique name for IP Set
    NsxtIpSetId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    description String
    An optional description of the IP Set
    ipAddresses List<String>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name String
    A unique name for IP Set
    nsxtIpSetId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    description string
    An optional description of the IP Set
    ipAddresses string[]
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name string
    A unique name for IP Set
    nsxtIpSetId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    description str
    An optional description of the IP Set
    ip_addresses Sequence[str]
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name str
    A unique name for IP Set
    nsxt_ip_set_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc str
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    description String
    An optional description of the IP Set
    ipAddresses List<String>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name String
    A unique name for IP Set
    nsxtIpSetId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    ID of VDC or VDC Group
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    ID of VDC or VDC Group
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    ID of VDC or VDC Group
    id string
    The provider-assigned unique ID for this managed resource.
    ownerId string
    ID of VDC or VDC Group
    id str
    The provider-assigned unique ID for this managed resource.
    owner_id str
    ID of VDC or VDC Group
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    ID of VDC or VDC Group

    Look up Existing NsxtIpSet Resource

    Get an existing NsxtIpSet 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?: NsxtIpSetState, opts?: CustomResourceOptions): NsxtIpSet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            edge_gateway_id: Optional[str] = None,
            ip_addresses: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            nsxt_ip_set_id: Optional[str] = None,
            org: Optional[str] = None,
            owner_id: Optional[str] = None,
            vdc: Optional[str] = None) -> NsxtIpSet
    func GetNsxtIpSet(ctx *Context, name string, id IDInput, state *NsxtIpSetState, opts ...ResourceOption) (*NsxtIpSet, error)
    public static NsxtIpSet Get(string name, Input<string> id, NsxtIpSetState? state, CustomResourceOptions? opts = null)
    public static NsxtIpSet get(String name, Output<String> id, NsxtIpSetState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtIpSet    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
    An optional description of the IP Set
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    IpAddresses List<string>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    Name string
    A unique name for IP Set
    NsxtIpSetId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OwnerId string
    ID of VDC or VDC Group
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Description string
    An optional description of the IP Set
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    IpAddresses []string
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    Name string
    A unique name for IP Set
    NsxtIpSetId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OwnerId string
    ID of VDC or VDC Group
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description String
    An optional description of the IP Set
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    ipAddresses List<String>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name String
    A unique name for IP Set
    nsxtIpSetId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId String
    ID of VDC or VDC Group
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description string
    An optional description of the IP Set
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    ipAddresses string[]
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name string
    A unique name for IP Set
    nsxtIpSetId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId string
    ID of VDC or VDC Group
    vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description str
    An optional description of the IP Set
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    ip_addresses Sequence[str]
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name str
    A unique name for IP Set
    nsxt_ip_set_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    owner_id str
    ID of VDC or VDC Group
    vdc str
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description String
    An optional description of the IP Set
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source.
    ipAddresses List<String>
    A set of IP addresses, subnets or ranges (IPv4 or IPv6)
    name String
    A unique name for IP Set
    nsxtIpSetId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId String
    ID of VDC or VDC Group
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware