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

vcd.NsxtEdgegatewayBgpIpPrefixList

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

    Create NsxtEdgegatewayBgpIpPrefixList Resource

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

    Constructor syntax

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

@overload
def NsxtEdgegatewayBgpIpPrefixList(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   edge_gateway_id: Optional[str] = None,
                                   ip_prefixes: Optional[Sequence[NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs]] = None,
                                   description: Optional[str] = None,
                                   name: Optional[str] = None,
                                   nsxt_edgegateway_bgp_ip_prefix_list_id: Optional[str] = None,
                                   org: Optional[str] = None)
    func NewNsxtEdgegatewayBgpIpPrefixList(ctx *Context, name string, args NsxtEdgegatewayBgpIpPrefixListArgs, opts ...ResourceOption) (*NsxtEdgegatewayBgpIpPrefixList, error)
    public NsxtEdgegatewayBgpIpPrefixList(string name, NsxtEdgegatewayBgpIpPrefixListArgs args, CustomResourceOptions? opts = null)
    public NsxtEdgegatewayBgpIpPrefixList(String name, NsxtEdgegatewayBgpIpPrefixListArgs args)
public NsxtEdgegatewayBgpIpPrefixList(String name, NsxtEdgegatewayBgpIpPrefixListArgs args, CustomResourceOptions options)

    type: vcd:NsxtEdgegatewayBgpIpPrefixList
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 NsxtEdgegatewayBgpIpPrefixListArgs
    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 NsxtEdgegatewayBgpIpPrefixListArgs
    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 NsxtEdgegatewayBgpIpPrefixListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayBgpIpPrefixListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtEdgegatewayBgpIpPrefixListArgs
    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 nsxtEdgegatewayBgpIpPrefixListResource = new Vcd.NsxtEdgegatewayBgpIpPrefixList("nsxtEdgegatewayBgpIpPrefixListResource", new()
{
    EdgeGatewayId = "string",
    IpPrefixes = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs
        {
            Action = "string",
            Network = "string",
            GreaterThanOrEqualTo = 0,
            LessThanOrEqualTo = 0,
        },
    },
    Description = "string",
    Name = "string",
    NsxtEdgegatewayBgpIpPrefixListId = "string",
    Org = "string",
});

    example, err := vcd.NewNsxtEdgegatewayBgpIpPrefixList(ctx, "nsxtEdgegatewayBgpIpPrefixListResource", &vcd.NsxtEdgegatewayBgpIpPrefixListArgs{
	EdgeGatewayId: pulumi.String("string"),
	IpPrefixes: vcd.NsxtEdgegatewayBgpIpPrefixListIpPrefixArray{
		&vcd.NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs{
			Action:               pulumi.String("string"),
			Network:              pulumi.String("string"),
			GreaterThanOrEqualTo: pulumi.Float64(0),
			LessThanOrEqualTo:    pulumi.Float64(0),
		},
	},
	Description:                      pulumi.String("string"),
	Name:                             pulumi.String("string"),
	NsxtEdgegatewayBgpIpPrefixListId: pulumi.String("string"),
	Org:                              pulumi.String("string"),
})

    var nsxtEdgegatewayBgpIpPrefixListResource = new NsxtEdgegatewayBgpIpPrefixList("nsxtEdgegatewayBgpIpPrefixListResource", NsxtEdgegatewayBgpIpPrefixListArgs.builder()
    .edgeGatewayId("string")
    .ipPrefixes(NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs.builder()
        .action("string")
        .network("string")
        .greaterThanOrEqualTo(0.0)
        .lessThanOrEqualTo(0.0)
        .build())
    .description("string")
    .name("string")
    .nsxtEdgegatewayBgpIpPrefixListId("string")
    .org("string")
    .build());

    nsxt_edgegateway_bgp_ip_prefix_list_resource = vcd.NsxtEdgegatewayBgpIpPrefixList("nsxtEdgegatewayBgpIpPrefixListResource",
    edge_gateway_id="string",
    ip_prefixes=[{
        "action": "string",
        "network": "string",
        "greater_than_or_equal_to": 0,
        "less_than_or_equal_to": 0,
    }],
    description="string",
    name="string",
    nsxt_edgegateway_bgp_ip_prefix_list_id="string",
    org="string")

    const nsxtEdgegatewayBgpIpPrefixListResource = new vcd.NsxtEdgegatewayBgpIpPrefixList("nsxtEdgegatewayBgpIpPrefixListResource", {
    edgeGatewayId: "string",
    ipPrefixes: [{
        action: "string",
        network: "string",
        greaterThanOrEqualTo: 0,
        lessThanOrEqualTo: 0,
    }],
    description: "string",
    name: "string",
    nsxtEdgegatewayBgpIpPrefixListId: "string",
    org: "string",
});

    type: vcd:NsxtEdgegatewayBgpIpPrefixList
properties:
    description: string
    edgeGatewayId: string
    ipPrefixes:
        - action: string
          greaterThanOrEqualTo: 0
          lessThanOrEqualTo: 0
          network: string
    name: string
    nsxtEdgegatewayBgpIpPrefixListId: string
    org: string

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

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    IpPrefixes List<NsxtEdgegatewayBgpIpPrefixListIpPrefix>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    Description string
    Description of IP Prefix List
    Name string
    The Name of IP Prefix List
    NsxtEdgegatewayBgpIpPrefixListId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    IpPrefixes []NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs

    At least one ip_prefix definition. See IP Prefix for definition structure.

    Description string
    Description of IP Prefix List
    Name string
    The Name of IP Prefix List
    NsxtEdgegatewayBgpIpPrefixListId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes List<NsxtEdgegatewayBgpIpPrefixListIpPrefix>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    description String
    Description of IP Prefix List
    name String
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes NsxtEdgegatewayBgpIpPrefixListIpPrefix[]

    At least one ip_prefix definition. See IP Prefix for definition structure.

    description string
    Description of IP Prefix List
    name string
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ip_prefixes Sequence[NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs]

    At least one ip_prefix definition. See IP Prefix for definition structure.

    description str
    Description of IP Prefix List
    name str
    The Name of IP Prefix List
    nsxt_edgegateway_bgp_ip_prefix_list_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
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes List<Property Map>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    description String
    Description of IP Prefix List
    name String
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsxtEdgegatewayBgpIpPrefixList 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 NsxtEdgegatewayBgpIpPrefixList Resource

    Get an existing NsxtEdgegatewayBgpIpPrefixList 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?: NsxtEdgegatewayBgpIpPrefixListState, opts?: CustomResourceOptions): NsxtEdgegatewayBgpIpPrefixList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        edge_gateway_id: Optional[str] = None,
        ip_prefixes: Optional[Sequence[NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs]] = None,
        name: Optional[str] = None,
        nsxt_edgegateway_bgp_ip_prefix_list_id: Optional[str] = None,
        org: Optional[str] = None) -> NsxtEdgegatewayBgpIpPrefixList
    func GetNsxtEdgegatewayBgpIpPrefixList(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayBgpIpPrefixListState, opts ...ResourceOption) (*NsxtEdgegatewayBgpIpPrefixList, error)
    public static NsxtEdgegatewayBgpIpPrefixList Get(string name, Input<string> id, NsxtEdgegatewayBgpIpPrefixListState? state, CustomResourceOptions? opts = null)
    public static NsxtEdgegatewayBgpIpPrefixList get(String name, Output<String> id, NsxtEdgegatewayBgpIpPrefixListState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtEdgegatewayBgpIpPrefixList    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 IP Prefix List
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    IpPrefixes List<NsxtEdgegatewayBgpIpPrefixListIpPrefix>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    Name string
    The Name of IP Prefix List
    NsxtEdgegatewayBgpIpPrefixListId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Description string
    Description of IP Prefix List
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    IpPrefixes []NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs

    At least one ip_prefix definition. See IP Prefix for definition structure.

    Name string
    The Name of IP Prefix List
    NsxtEdgegatewayBgpIpPrefixListId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    description String
    Description of IP Prefix List
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes List<NsxtEdgegatewayBgpIpPrefixListIpPrefix>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    name String
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    description string
    Description of IP Prefix List
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes NsxtEdgegatewayBgpIpPrefixListIpPrefix[]

    At least one ip_prefix definition. See IP Prefix for definition structure.

    name string
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    description str
    Description of IP Prefix List
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ip_prefixes Sequence[NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs]

    At least one ip_prefix definition. See IP Prefix for definition structure.

    name str
    The Name of IP Prefix List
    nsxt_edgegateway_bgp_ip_prefix_list_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
    description String
    Description of IP Prefix List
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway datasource
    ipPrefixes List<Property Map>

    At least one ip_prefix definition. See IP Prefix for definition structure.

    name String
    The Name of IP Prefix List
    nsxtEdgegatewayBgpIpPrefixListId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

    Supporting Types

    NsxtEdgegatewayBgpIpPrefixListIpPrefix, NsxtEdgegatewayBgpIpPrefixListIpPrefixArgs

    Action string
    Action 'PERMIT' or 'DENY'
    Network string
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    GreaterThanOrEqualTo double
    Greater than or equal to subnet mask
    LessThanOrEqualTo double
    Less than or equal to subnet mask
    Action string
    Action 'PERMIT' or 'DENY'
    Network string
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    GreaterThanOrEqualTo float64
    Greater than or equal to subnet mask
    LessThanOrEqualTo float64
    Less than or equal to subnet mask
    action String
    Action 'PERMIT' or 'DENY'
    network String
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    greaterThanOrEqualTo Double
    Greater than or equal to subnet mask
    lessThanOrEqualTo Double
    Less than or equal to subnet mask
    action string
    Action 'PERMIT' or 'DENY'
    network string
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    greaterThanOrEqualTo number
    Greater than or equal to subnet mask
    lessThanOrEqualTo number
    Less than or equal to subnet mask
    action str
    Action 'PERMIT' or 'DENY'
    network str
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    greater_than_or_equal_to float
    Greater than or equal to subnet mask
    less_than_or_equal_to float
    Less than or equal to subnet mask
    action String
    Action 'PERMIT' or 'DENY'
    network String
    Network in CIDR notation (e.g. '192.168.100.0/24', '2001:db8::/48')
    greaterThanOrEqualTo Number
    Greater than or equal to subnet mask
    lessThanOrEqualTo Number
    Less than or equal to subnet mask

    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