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

vcd.NsxtEdgegatewayDhcpForwarding

Explore with Pulumi AI

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

    Create NsxtEdgegatewayDhcpForwarding Resource

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

    Constructor syntax

    new NsxtEdgegatewayDhcpForwarding(name: string, args: NsxtEdgegatewayDhcpForwardingArgs, opts?: CustomResourceOptions);
    @overload
    def NsxtEdgegatewayDhcpForwarding(resource_name: str,
                                      args: NsxtEdgegatewayDhcpForwardingArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def NsxtEdgegatewayDhcpForwarding(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      dhcp_servers: Optional[Sequence[str]] = None,
                                      edge_gateway_id: Optional[str] = None,
                                      enabled: Optional[bool] = None,
                                      nsxt_edgegateway_dhcp_forwarding_id: Optional[str] = None,
                                      org: Optional[str] = None)
    func NewNsxtEdgegatewayDhcpForwarding(ctx *Context, name string, args NsxtEdgegatewayDhcpForwardingArgs, opts ...ResourceOption) (*NsxtEdgegatewayDhcpForwarding, error)
    public NsxtEdgegatewayDhcpForwarding(string name, NsxtEdgegatewayDhcpForwardingArgs args, CustomResourceOptions? opts = null)
    public NsxtEdgegatewayDhcpForwarding(String name, NsxtEdgegatewayDhcpForwardingArgs args)
    public NsxtEdgegatewayDhcpForwarding(String name, NsxtEdgegatewayDhcpForwardingArgs args, CustomResourceOptions options)
    
    type: vcd:NsxtEdgegatewayDhcpForwarding
    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 NsxtEdgegatewayDhcpForwardingArgs
    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 NsxtEdgegatewayDhcpForwardingArgs
    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 NsxtEdgegatewayDhcpForwardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayDhcpForwardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtEdgegatewayDhcpForwardingArgs
    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 nsxtEdgegatewayDhcpForwardingResource = new Vcd.NsxtEdgegatewayDhcpForwarding("nsxtEdgegatewayDhcpForwardingResource", new()
    {
        DhcpServers = new[]
        {
            "string",
        },
        EdgeGatewayId = "string",
        Enabled = false,
        NsxtEdgegatewayDhcpForwardingId = "string",
        Org = "string",
    });
    
    example, err := vcd.NewNsxtEdgegatewayDhcpForwarding(ctx, "nsxtEdgegatewayDhcpForwardingResource", &vcd.NsxtEdgegatewayDhcpForwardingArgs{
    	DhcpServers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	EdgeGatewayId:                   pulumi.String("string"),
    	Enabled:                         pulumi.Bool(false),
    	NsxtEdgegatewayDhcpForwardingId: pulumi.String("string"),
    	Org:                             pulumi.String("string"),
    })
    
    var nsxtEdgegatewayDhcpForwardingResource = new NsxtEdgegatewayDhcpForwarding("nsxtEdgegatewayDhcpForwardingResource", NsxtEdgegatewayDhcpForwardingArgs.builder()
        .dhcpServers("string")
        .edgeGatewayId("string")
        .enabled(false)
        .nsxtEdgegatewayDhcpForwardingId("string")
        .org("string")
        .build());
    
    nsxt_edgegateway_dhcp_forwarding_resource = vcd.NsxtEdgegatewayDhcpForwarding("nsxtEdgegatewayDhcpForwardingResource",
        dhcp_servers=["string"],
        edge_gateway_id="string",
        enabled=False,
        nsxt_edgegateway_dhcp_forwarding_id="string",
        org="string")
    
    const nsxtEdgegatewayDhcpForwardingResource = new vcd.NsxtEdgegatewayDhcpForwarding("nsxtEdgegatewayDhcpForwardingResource", {
        dhcpServers: ["string"],
        edgeGatewayId: "string",
        enabled: false,
        nsxtEdgegatewayDhcpForwardingId: "string",
        org: "string",
    });
    
    type: vcd:NsxtEdgegatewayDhcpForwarding
    properties:
        dhcpServers:
            - string
        edgeGatewayId: string
        enabled: false
        nsxtEdgegatewayDhcpForwardingId: string
        org: string
    

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

    DhcpServers List<string>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    EdgeGatewayId string
    NSX-T Edge Gateway ID.
    Enabled bool
    DHCP Forwarding status.
    NsxtEdgegatewayDhcpForwardingId string
    Org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    DhcpServers []string

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    EdgeGatewayId string
    NSX-T Edge Gateway ID.
    Enabled bool
    DHCP Forwarding status.
    NsxtEdgegatewayDhcpForwardingId string
    Org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers List<String>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId String
    NSX-T Edge Gateway ID.
    enabled Boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId String
    org String
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers string[]

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId string
    NSX-T Edge Gateway ID.
    enabled boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId string
    org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcp_servers Sequence[str]

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edge_gateway_id str
    NSX-T Edge Gateway ID.
    enabled bool
    DHCP Forwarding status.
    nsxt_edgegateway_dhcp_forwarding_id str
    org str
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers List<String>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId String
    NSX-T Edge Gateway ID.
    enabled Boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId String
    org String
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.

    Outputs

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

    Get an existing NsxtEdgegatewayDhcpForwarding 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?: NsxtEdgegatewayDhcpForwardingState, opts?: CustomResourceOptions): NsxtEdgegatewayDhcpForwarding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dhcp_servers: Optional[Sequence[str]] = None,
            edge_gateway_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            nsxt_edgegateway_dhcp_forwarding_id: Optional[str] = None,
            org: Optional[str] = None) -> NsxtEdgegatewayDhcpForwarding
    func GetNsxtEdgegatewayDhcpForwarding(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayDhcpForwardingState, opts ...ResourceOption) (*NsxtEdgegatewayDhcpForwarding, error)
    public static NsxtEdgegatewayDhcpForwarding Get(string name, Input<string> id, NsxtEdgegatewayDhcpForwardingState? state, CustomResourceOptions? opts = null)
    public static NsxtEdgegatewayDhcpForwarding get(String name, Output<String> id, NsxtEdgegatewayDhcpForwardingState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtEdgegatewayDhcpForwarding    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:
    DhcpServers List<string>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    EdgeGatewayId string
    NSX-T Edge Gateway ID.
    Enabled bool
    DHCP Forwarding status.
    NsxtEdgegatewayDhcpForwardingId string
    Org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    DhcpServers []string

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    EdgeGatewayId string
    NSX-T Edge Gateway ID.
    Enabled bool
    DHCP Forwarding status.
    NsxtEdgegatewayDhcpForwardingId string
    Org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers List<String>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId String
    NSX-T Edge Gateway ID.
    enabled Boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId String
    org String
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers string[]

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId string
    NSX-T Edge Gateway ID.
    enabled boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId string
    org string
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcp_servers Sequence[str]

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edge_gateway_id str
    NSX-T Edge Gateway ID.
    enabled bool
    DHCP Forwarding status.
    nsxt_edgegateway_dhcp_forwarding_id str
    org str
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.
    dhcpServers List<String>

    IP addresses of DHCP servers. Maximum 8 can be specified.

    Modification of the dhcp_servers field will not be changed in VCD when enabled = false because VCD API ignores DHCP server changes when DHCP forwarding is disabled.

    edgeGatewayId String
    NSX-T Edge Gateway ID.
    enabled Boolean
    DHCP Forwarding status.
    nsxtEdgegatewayDhcpForwardingId String
    org String
    Org in which the NSX-T Edge Gateway is located, required if not set in the provider section.

    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