1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxvIpSet
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxvIpSet

Get Started
vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create NsxvIpSet Resource

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

    Constructor syntax

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

@overload
def NsxvIpSet(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              ip_addresses: Optional[Sequence[str]] = None,
              description: Optional[str] = None,
              is_inheritance_allowed: Optional[bool] = None,
              name: Optional[str] = None,
              nsxv_ip_set_id: Optional[str] = None,
              org: Optional[str] = None,
              vdc: Optional[str] = None)
    func NewNsxvIpSet(ctx *Context, name string, args NsxvIpSetArgs, opts ...ResourceOption) (*NsxvIpSet, error)
    public NsxvIpSet(string name, NsxvIpSetArgs args, CustomResourceOptions? opts = null)
    public NsxvIpSet(String name, NsxvIpSetArgs args)
public NsxvIpSet(String name, NsxvIpSetArgs args, CustomResourceOptions options)

    type: vcd:NsxvIpSet
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 NsxvIpSetArgs
    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 NsxvIpSetArgs
    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 NsxvIpSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxvIpSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxvIpSetArgs
    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 nsxvIpSetResource = new Vcd.NsxvIpSet("nsxvIpSetResource", new()
{
    IpAddresses = new[]
    {
        "string",
    },
    Description = "string",
    IsInheritanceAllowed = false,
    Name = "string",
    NsxvIpSetId = "string",
    Org = "string",
    Vdc = "string",
});

    example, err := vcd.NewNsxvIpSet(ctx, "nsxvIpSetResource", &vcd.NsxvIpSetArgs{
	IpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:          pulumi.String("string"),
	IsInheritanceAllowed: pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	NsxvIpSetId:          pulumi.String("string"),
	Org:                  pulumi.String("string"),
	Vdc:                  pulumi.String("string"),
})

    var nsxvIpSetResource = new NsxvIpSet("nsxvIpSetResource", NsxvIpSetArgs.builder()
    .ipAddresses("string")
    .description("string")
    .isInheritanceAllowed(false)
    .name("string")
    .nsxvIpSetId("string")
    .org("string")
    .vdc("string")
    .build());

    nsxv_ip_set_resource = vcd.NsxvIpSet("nsxvIpSetResource",
    ip_addresses=["string"],
    description="string",
    is_inheritance_allowed=False,
    name="string",
    nsxv_ip_set_id="string",
    org="string",
    vdc="string")

    const nsxvIpSetResource = new vcd.NsxvIpSet("nsxvIpSetResource", {
    ipAddresses: ["string"],
    description: "string",
    isInheritanceAllowed: false,
    name: "string",
    nsxvIpSetId: "string",
    org: "string",
    vdc: "string",
});

    type: vcd:NsxvIpSet
properties:
    description: string
    ipAddresses:
        - string
    isInheritanceAllowed: false
    name: string
    nsxvIpSetId: string
    org: string
    vdc: string

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

    IpAddresses List<string>
    A set of IP addresses, CIDRs and ranges as strings.
    Description string
    An optional description for IP set.
    IsInheritanceAllowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    Name string
    Unique IP set name.
    NsxvIpSetId string
    ID of IP set
    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
    IpAddresses []string
    A set of IP addresses, CIDRs and ranges as strings.
    Description string
    An optional description for IP set.
    IsInheritanceAllowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    Name string
    Unique IP set name.
    NsxvIpSetId string
    ID of IP set
    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
    ipAddresses List<String>
    A set of IP addresses, CIDRs and ranges as strings.
    description String
    An optional description for IP set.
    isInheritanceAllowed Boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name String
    Unique IP set name.
    nsxvIpSetId String
    ID of IP set
    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
    ipAddresses string[]
    A set of IP addresses, CIDRs and ranges as strings.
    description string
    An optional description for IP set.
    isInheritanceAllowed boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name string
    Unique IP set name.
    nsxvIpSetId string
    ID of IP set
    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
    ip_addresses Sequence[str]
    A set of IP addresses, CIDRs and ranges as strings.
    description str
    An optional description for IP set.
    is_inheritance_allowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name str
    Unique IP set name.
    nsxv_ip_set_id str
    ID of IP set
    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
    ipAddresses List<String>
    A set of IP addresses, CIDRs and ranges as strings.
    description String
    An optional description for IP set.
    isInheritanceAllowed Boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name String
    Unique IP set name.
    nsxvIpSetId String
    ID of IP set
    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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NsxvIpSet Resource

    Get an existing NsxvIpSet 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?: NsxvIpSetState, opts?: CustomResourceOptions): NsxvIpSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        is_inheritance_allowed: Optional[bool] = None,
        name: Optional[str] = None,
        nsxv_ip_set_id: Optional[str] = None,
        org: Optional[str] = None,
        vdc: Optional[str] = None) -> NsxvIpSet
    func GetNsxvIpSet(ctx *Context, name string, id IDInput, state *NsxvIpSetState, opts ...ResourceOption) (*NsxvIpSet, error)
    public static NsxvIpSet Get(string name, Input<string> id, NsxvIpSetState? state, CustomResourceOptions? opts = null)
    public static NsxvIpSet get(String name, Output<String> id, NsxvIpSetState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxvIpSet    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 for IP set.
    IpAddresses List<string>
    A set of IP addresses, CIDRs and ranges as strings.
    IsInheritanceAllowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    Name string
    Unique IP set name.
    NsxvIpSetId string
    ID of IP set
    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
    Description string
    An optional description for IP set.
    IpAddresses []string
    A set of IP addresses, CIDRs and ranges as strings.
    IsInheritanceAllowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    Name string
    Unique IP set name.
    NsxvIpSetId string
    ID of IP set
    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
    description String
    An optional description for IP set.
    ipAddresses List<String>
    A set of IP addresses, CIDRs and ranges as strings.
    isInheritanceAllowed Boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name String
    Unique IP set name.
    nsxvIpSetId String
    ID of IP set
    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
    description string
    An optional description for IP set.
    ipAddresses string[]
    A set of IP addresses, CIDRs and ranges as strings.
    isInheritanceAllowed boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name string
    Unique IP set name.
    nsxvIpSetId string
    ID of IP set
    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
    description str
    An optional description for IP set.
    ip_addresses Sequence[str]
    A set of IP addresses, CIDRs and ranges as strings.
    is_inheritance_allowed bool
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name str
    Unique IP set name.
    nsxv_ip_set_id str
    ID of IP set
    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
    description String
    An optional description for IP set.
    ipAddresses List<String>
    A set of IP addresses, CIDRs and ranges as strings.
    isInheritanceAllowed Boolean
    Toggle to enable inheritance to allow visibility at underlying scopes. Default true
    name String
    Unique IP set name.
    nsxvIpSetId String
    ID of IP set
    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

    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
    vmware/terraform-provider-vcd
      Meet Neo: Your AI Platform Teammate