1. Packages
  2. Outscale Provider
  3. API Docs
  4. getDhcpOption
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale

outscale.getDhcpOption

Explore with Pulumi AI

Provides information about a DHCP option.

For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";

const dhcpOption01 = outscale.getDhcpOption({
    filters: [{
        name: "dhcp_options_set_id",
        values: ["dopt-12345678"],
    }],
});
Copy
import pulumi
import pulumi_outscale as outscale

dhcp_option01 = outscale.get_dhcp_option(filters=[{
    "name": "dhcp_options_set_id",
    "values": ["dopt-12345678"],
}])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.LookupDhcpOption(ctx, &outscale.LookupDhcpOptionArgs{
			Filters: []outscale.GetDhcpOptionFilter{
				{
					Name: "dhcp_options_set_id",
					Values: []string{
						"dopt-12345678",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var dhcpOption01 = Outscale.GetDhcpOption.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetDhcpOptionFilterInputArgs
            {
                Name = "dhcp_options_set_id",
                Values = new[]
                {
                    "dopt-12345678",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetDhcpOptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var dhcpOption01 = OutscaleFunctions.getDhcpOption(GetDhcpOptionArgs.builder()
            .filters(GetDhcpOptionFilterArgs.builder()
                .name("dhcp_options_set_id")
                .values("dopt-12345678")
                .build())
            .build());

    }
}
Copy
variables:
  dhcpOption01:
    fn::invoke:
      function: outscale:getDhcpOption
      arguments:
        filters:
          - name: dhcp_options_set_id
            values:
              - dopt-12345678
Copy

Using getDhcpOption

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDhcpOption(args: GetDhcpOptionArgs, opts?: InvokeOptions): Promise<GetDhcpOptionResult>
function getDhcpOptionOutput(args: GetDhcpOptionOutputArgs, opts?: InvokeOptions): Output<GetDhcpOptionResult>
Copy
def get_dhcp_option(filters: Optional[Sequence[GetDhcpOptionFilter]] = None,
                    id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDhcpOptionResult
def get_dhcp_option_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDhcpOptionFilterArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDhcpOptionResult]
Copy
func LookupDhcpOption(ctx *Context, args *LookupDhcpOptionArgs, opts ...InvokeOption) (*LookupDhcpOptionResult, error)
func LookupDhcpOptionOutput(ctx *Context, args *LookupDhcpOptionOutputArgs, opts ...InvokeOption) LookupDhcpOptionResultOutput
Copy

> Note: This function is named LookupDhcpOption in the Go SDK.

public static class GetDhcpOption 
{
    public static Task<GetDhcpOptionResult> InvokeAsync(GetDhcpOptionArgs args, InvokeOptions? opts = null)
    public static Output<GetDhcpOptionResult> Invoke(GetDhcpOptionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDhcpOptionResult> getDhcpOption(GetDhcpOptionArgs args, InvokeOptions options)
public static Output<GetDhcpOptionResult> getDhcpOption(GetDhcpOptionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getDhcpOption:getDhcpOption
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetDhcpOptionFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
Filters []GetDhcpOptionFilter
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
filters List<GetDhcpOptionFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
filters GetDhcpOptionFilter[]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id string
filters Sequence[GetDhcpOptionFilter]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id str
filters List<Property Map>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String

getDhcpOption Result

The following output properties are available:

Default bool
If true, the DHCP options set is a default one. If false, it is not.
DhcpOptionsSetId string
The ID of the DHCP options set.
DomainName string
The domain name.
DomainNameServers List<string>
One or more IPs for the domain name servers.
Id string
LogServers List<string>
One or more IPs for the log servers.
NtpServers List<string>
One or more IPs for the NTP servers.
RequestId string
Tags List<GetDhcpOptionTag>
One or more tags associated with the DHCP options set.
Filters List<GetDhcpOptionFilter>
Default bool
If true, the DHCP options set is a default one. If false, it is not.
DhcpOptionsSetId string
The ID of the DHCP options set.
DomainName string
The domain name.
DomainNameServers []string
One or more IPs for the domain name servers.
Id string
LogServers []string
One or more IPs for the log servers.
NtpServers []string
One or more IPs for the NTP servers.
RequestId string
Tags []GetDhcpOptionTag
One or more tags associated with the DHCP options set.
Filters []GetDhcpOptionFilter
default_ Boolean
If true, the DHCP options set is a default one. If false, it is not.
dhcpOptionsSetId String
The ID of the DHCP options set.
domainName String
The domain name.
domainNameServers List<String>
One or more IPs for the domain name servers.
id String
logServers List<String>
One or more IPs for the log servers.
ntpServers List<String>
One or more IPs for the NTP servers.
requestId String
tags List<GetDhcpOptionTag>
One or more tags associated with the DHCP options set.
filters List<GetDhcpOptionFilter>
default boolean
If true, the DHCP options set is a default one. If false, it is not.
dhcpOptionsSetId string
The ID of the DHCP options set.
domainName string
The domain name.
domainNameServers string[]
One or more IPs for the domain name servers.
id string
logServers string[]
One or more IPs for the log servers.
ntpServers string[]
One or more IPs for the NTP servers.
requestId string
tags GetDhcpOptionTag[]
One or more tags associated with the DHCP options set.
filters GetDhcpOptionFilter[]
default bool
If true, the DHCP options set is a default one. If false, it is not.
dhcp_options_set_id str
The ID of the DHCP options set.
domain_name str
The domain name.
domain_name_servers Sequence[str]
One or more IPs for the domain name servers.
id str
log_servers Sequence[str]
One or more IPs for the log servers.
ntp_servers Sequence[str]
One or more IPs for the NTP servers.
request_id str
tags Sequence[GetDhcpOptionTag]
One or more tags associated with the DHCP options set.
filters Sequence[GetDhcpOptionFilter]
default Boolean
If true, the DHCP options set is a default one. If false, it is not.
dhcpOptionsSetId String
The ID of the DHCP options set.
domainName String
The domain name.
domainNameServers List<String>
One or more IPs for the domain name servers.
id String
logServers List<String>
One or more IPs for the log servers.
ntpServers List<String>
One or more IPs for the NTP servers.
requestId String
tags List<Property Map>
One or more tags associated with the DHCP options set.
filters List<Property Map>

Supporting Types

GetDhcpOptionFilter

Name This property is required. string
Values This property is required. List<string>
Name This property is required. string
Values This property is required. []string
name This property is required. String
values This property is required. List<String>
name This property is required. string
values This property is required. string[]
name This property is required. str
values This property is required. Sequence[str]
name This property is required. String
values This property is required. List<String>

GetDhcpOptionTag

Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.
key This property is required. string
The key of the tag, with a minimum of 1 character.
value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. str
The key of the tag, with a minimum of 1 character.
value This property is required. str
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.