Retrieves a listing of config items.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const pagedInterfaceList = scm.getDhcpInterfaceList({
folder: "All",
limit: 10,
});
export const fetchedInterfaceListSummary = {
countOfRulesFetched: pagedInterfaceList.then(pagedInterfaceList => pagedInterfaceList.total),
firstRuleName: pagedInterfaceList.then(pagedInterfaceList => pagedInterfaceList.datas),
};
import pulumi
import pulumi_scm as scm
paged_interface_list = scm.get_dhcp_interface_list(folder="All",
limit=10)
pulumi.export("fetchedInterfaceListSummary", {
"countOfRulesFetched": paged_interface_list.total,
"firstRuleName": paged_interface_list.datas,
})
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
pagedInterfaceList, err := scm.GetDhcpInterfaceList(ctx, &scm.GetDhcpInterfaceListArgs{
Folder: pulumi.StringRef("All"),
Limit: pulumi.IntRef(10),
}, nil)
if err != nil {
return err
}
ctx.Export("fetchedInterfaceListSummary", pulumi.Map{
"countOfRulesFetched": pagedInterfaceList.Total,
"firstRuleName": pagedInterfaceList.Datas,
})
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var pagedInterfaceList = Scm.GetDhcpInterfaceList.Invoke(new()
{
Folder = "All",
Limit = 10,
});
return new Dictionary<string, object?>
{
["fetchedInterfaceListSummary"] =
{
{ "countOfRulesFetched", pagedInterfaceList.Apply(getDhcpInterfaceListResult => getDhcpInterfaceListResult.Total) },
{ "firstRuleName", pagedInterfaceList.Apply(getDhcpInterfaceListResult => getDhcpInterfaceListResult.Datas) },
},
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetDhcpInterfaceListArgs;
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 pagedInterfaceList = ScmFunctions.getDhcpInterfaceList(GetDhcpInterfaceListArgs.builder()
.folder("All")
.limit(10)
.build());
ctx.export("fetchedInterfaceListSummary", Map.ofEntries(
Map.entry("countOfRulesFetched", pagedInterfaceList.total()),
Map.entry("firstRuleName", pagedInterfaceList.datas())
));
}
}
variables:
pagedInterfaceList:
fn::invoke:
function: scm:getDhcpInterfaceList
arguments:
folder: All
limit: 10
outputs:
fetchedInterfaceListSummary:
countOfRulesFetched: ${pagedInterfaceList.total}
firstRuleName: ${pagedInterfaceList.datas}
Using getDhcpInterfaceList
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 getDhcpInterfaceList(args: GetDhcpInterfaceListArgs, opts?: InvokeOptions): Promise<GetDhcpInterfaceListResult>
function getDhcpInterfaceListOutput(args: GetDhcpInterfaceListOutputArgs, opts?: InvokeOptions): Output<GetDhcpInterfaceListResult>def get_dhcp_interface_list(device: Optional[str] = None,
folder: Optional[str] = None,
limit: Optional[int] = None,
name: Optional[str] = None,
offset: Optional[int] = None,
snippet: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDhcpInterfaceListResult
def get_dhcp_interface_list_output(device: Optional[pulumi.Input[str]] = None,
folder: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
offset: Optional[pulumi.Input[int]] = None,
snippet: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDhcpInterfaceListResult]func GetDhcpInterfaceList(ctx *Context, args *GetDhcpInterfaceListArgs, opts ...InvokeOption) (*GetDhcpInterfaceListResult, error)
func GetDhcpInterfaceListOutput(ctx *Context, args *GetDhcpInterfaceListOutputArgs, opts ...InvokeOption) GetDhcpInterfaceListResultOutput> Note: This function is named GetDhcpInterfaceList in the Go SDK.
public static class GetDhcpInterfaceList
{
public static Task<GetDhcpInterfaceListResult> InvokeAsync(GetDhcpInterfaceListArgs args, InvokeOptions? opts = null)
public static Output<GetDhcpInterfaceListResult> Invoke(GetDhcpInterfaceListInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDhcpInterfaceListResult> getDhcpInterfaceList(GetDhcpInterfaceListArgs args, InvokeOptions options)
public static Output<GetDhcpInterfaceListResult> getDhcpInterfaceList(GetDhcpInterfaceListArgs args, InvokeOptions options)
fn::invoke:
function: scm:index/getDhcpInterfaceList:getDhcpInterfaceList
arguments:
# arguments dictionaryThe following arguments are supported:
getDhcpInterfaceList Result
The following output properties are available:
- Datas
List<Get
Dhcp Interface List Data> - The data.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- Total int
- The total number of items.
- Device string
- The device of the item.
- Folder string
- The folder of the item. Default: Shared.
- Limit int
- The max number of items to return. Default: 200.
- Name string
- The name of the item.
- Offset int
- The offset of the first item to return.
- Snippet string
- The snippet of the item.
- Datas
[]Get
Dhcp Interface List Data - The data.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- Total int
- The total number of items.
- Device string
- The device of the item.
- Folder string
- The folder of the item. Default: Shared.
- Limit int
- The max number of items to return. Default: 200.
- Name string
- The name of the item.
- Offset int
- The offset of the first item to return.
- Snippet string
- The snippet of the item.
- datas
List<Get
Dhcp Interface List Data> - The data.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
- total Integer
- The total number of items.
- device String
- The device of the item.
- folder String
- The folder of the item. Default: Shared.
- limit Integer
- The max number of items to return. Default: 200.
- name String
- The name of the item.
- offset Integer
- The offset of the first item to return.
- snippet String
- The snippet of the item.
- datas
Get
Dhcp Interface List Data[] - The data.
- id string
- The provider-assigned unique ID for this managed resource.
- tfid string
- total number
- The total number of items.
- device string
- The device of the item.
- folder string
- The folder of the item. Default: Shared.
- limit number
- The max number of items to return. Default: 200.
- name string
- The name of the item.
- offset number
- The offset of the first item to return.
- snippet string
- The snippet of the item.
- datas
Sequence[Get
Dhcp Interface List Data] - The data.
- id str
- The provider-assigned unique ID for this managed resource.
- tfid str
- total int
- The total number of items.
- device str
- The device of the item.
- folder str
- The folder of the item. Default: Shared.
- limit int
- The max number of items to return. Default: 200.
- name str
- The name of the item.
- offset int
- The offset of the first item to return.
- snippet str
- The snippet of the item.
- datas List<Property Map>
- The data.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
- total Number
- The total number of items.
- device String
- The device of the item.
- folder String
- The folder of the item. Default: Shared.
- limit Number
- The max number of items to return. Default: 200.
- name String
- The name of the item.
- offset Number
- The offset of the first item to return.
- snippet String
- The snippet of the item.
Supporting Types
GetDhcpInterfaceListData
- Device string
- The device in which the resource is defined
- Folder string
- The folder of the item. Default: Shared.
- Id string
- UUID of the resource
- Name string
- The name of the item.
- Relay
Get
Dhcp Interface List Data Relay Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- Server
Get
Dhcp Interface List Data Server Server
ℹ️ Note: You must specify exactly one of
relayandserver.- Snippet string
- The snippet of the item.
- Tfid string
- Device string
- The device in which the resource is defined
- Folder string
- The folder of the item. Default: Shared.
- Id string
- UUID of the resource
- Name string
- The name of the item.
- Relay
Get
Dhcp Interface List Data Relay Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- Server
Get
Dhcp Interface List Data Server Server
ℹ️ Note: You must specify exactly one of
relayandserver.- Snippet string
- The snippet of the item.
- Tfid string
- device String
- The device in which the resource is defined
- folder String
- The folder of the item. Default: Shared.
- id String
- UUID of the resource
- name String
- The name of the item.
- relay
Get
Dhcp Interface List Data Relay Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- server
Get
Dhcp Interface List Data Server Server
ℹ️ Note: You must specify exactly one of
relayandserver.- snippet String
- The snippet of the item.
- tfid String
- device string
- The device in which the resource is defined
- folder string
- The folder of the item. Default: Shared.
- id string
- UUID of the resource
- name string
- The name of the item.
- relay
Get
Dhcp Interface List Data Relay Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- server
Get
Dhcp Interface List Data Server Server
ℹ️ Note: You must specify exactly one of
relayandserver.- snippet string
- The snippet of the item.
- tfid string
- device str
- The device in which the resource is defined
- folder str
- The folder of the item. Default: Shared.
- id str
- UUID of the resource
- name str
- The name of the item.
- relay
Get
Dhcp Interface List Data Relay Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- server
Get
Dhcp Interface List Data Server Server
ℹ️ Note: You must specify exactly one of
relayandserver.- snippet str
- The snippet of the item.
- tfid str
- device String
- The device in which the resource is defined
- folder String
- The folder of the item. Default: Shared.
- id String
- UUID of the resource
- name String
- The name of the item.
- relay Property Map
Relay
ℹ️ Note: You must specify exactly one of
relayandserver.- server Property Map
Server
ℹ️ Note: You must specify exactly one of
relayandserver.- snippet String
- The snippet of the item.
- tfid String
GetDhcpInterfaceListDataRelay
GetDhcpInterfaceListDataRelayIp
GetDhcpInterfaceListDataServer
- Ip
Pools List<string> - List of IP address pools
- Mode string
- DHCP server mode
- Option
Get
Dhcp Interface List Data Server Option - Option
- Probe
Ip bool - Ping IP before allocating?
- Reserveds
List<Get
Dhcp Interface List Data Server Reserved> - List of IP reservations
- Ip
Pools []string - List of IP address pools
- Mode string
- DHCP server mode
- Option
Get
Dhcp Interface List Data Server Option - Option
- Probe
Ip bool - Ping IP before allocating?
- Reserveds
[]Get
Dhcp Interface List Data Server Reserved - List of IP reservations
- ip
Pools List<String> - List of IP address pools
- mode String
- DHCP server mode
- option
Get
Dhcp Interface List Data Server Option - Option
- probe
Ip Boolean - Ping IP before allocating?
- reserveds
List<Get
Dhcp Interface List Data Server Reserved> - List of IP reservations
- ip
Pools string[] - List of IP address pools
- mode string
- DHCP server mode
- option
Get
Dhcp Interface List Data Server Option - Option
- probe
Ip boolean - Ping IP before allocating?
- reserveds
Get
Dhcp Interface List Data Server Reserved[] - List of IP reservations
- ip_
pools Sequence[str] - List of IP address pools
- mode str
- DHCP server mode
- option
Get
Dhcp Interface List Data Server Option - Option
- probe_
ip bool - Ping IP before allocating?
- reserveds
Sequence[Get
Dhcp Interface List Data Server Reserved] - List of IP reservations
- ip
Pools List<String> - List of IP address pools
- mode String
- DHCP server mode
- option Property Map
- Option
- probe
Ip Boolean - Ping IP before allocating?
- reserveds List<Property Map>
- List of IP reservations
GetDhcpInterfaceListDataServerOption
- Dns
Get
Dhcp Interface List Data Server Option Dns - Dns
- Dns
Suffix string - DNS suffix
- Gateway string
- Default gateway
- Inheritance
Get
Dhcp Interface List Data Server Option Inheritance - Inheritance
- Lease
Get
Dhcp Interface List Data Server Option Lease - Lease
- Nis
Get
Dhcp Interface List Data Server Option Nis - Nis
- Ntp
Get
Dhcp Interface List Data Server Option Ntp - Ntp
- Pop3Server string
- POP3 server
- Smtp
Server string - SMTP server
- Subnet
Mask string - Subnet mask
- User
Defineds List<GetDhcp Interface List Data Server Option User Defined> - Custom DHCP options
- Wins
Get
Dhcp Interface List Data Server Option Wins - Wins
- Dns
Get
Dhcp Interface List Data Server Option Dns - Dns
- Dns
Suffix string - DNS suffix
- Gateway string
- Default gateway
- Inheritance
Get
Dhcp Interface List Data Server Option Inheritance - Inheritance
- Lease
Get
Dhcp Interface List Data Server Option Lease - Lease
- Nis
Get
Dhcp Interface List Data Server Option Nis - Nis
- Ntp
Get
Dhcp Interface List Data Server Option Ntp - Ntp
- Pop3Server string
- POP3 server
- Smtp
Server string - SMTP server
- Subnet
Mask string - Subnet mask
- User
Defineds []GetDhcp Interface List Data Server Option User Defined - Custom DHCP options
- Wins
Get
Dhcp Interface List Data Server Option Wins - Wins
- dns
Get
Dhcp Interface List Data Server Option Dns - Dns
- dns
Suffix String - DNS suffix
- gateway String
- Default gateway
- inheritance
Get
Dhcp Interface List Data Server Option Inheritance - Inheritance
- lease
Get
Dhcp Interface List Data Server Option Lease - Lease
- nis
Get
Dhcp Interface List Data Server Option Nis - Nis
- ntp
Get
Dhcp Interface List Data Server Option Ntp - Ntp
- pop3Server String
- POP3 server
- smtp
Server String - SMTP server
- subnet
Mask String - Subnet mask
- user
Defineds List<GetDhcp Interface List Data Server Option User Defined> - Custom DHCP options
- wins
Get
Dhcp Interface List Data Server Option Wins - Wins
- dns
Get
Dhcp Interface List Data Server Option Dns - Dns
- dns
Suffix string - DNS suffix
- gateway string
- Default gateway
- inheritance
Get
Dhcp Interface List Data Server Option Inheritance - Inheritance
- lease
Get
Dhcp Interface List Data Server Option Lease - Lease
- nis
Get
Dhcp Interface List Data Server Option Nis - Nis
- ntp
Get
Dhcp Interface List Data Server Option Ntp - Ntp
- pop3Server string
- POP3 server
- smtp
Server string - SMTP server
- subnet
Mask string - Subnet mask
- user
Defineds GetDhcp Interface List Data Server Option User Defined[] - Custom DHCP options
- wins
Get
Dhcp Interface List Data Server Option Wins - Wins
- dns
Get
Dhcp Interface List Data Server Option Dns - Dns
- dns_
suffix str - DNS suffix
- gateway str
- Default gateway
- inheritance
Get
Dhcp Interface List Data Server Option Inheritance - Inheritance
- lease
Get
Dhcp Interface List Data Server Option Lease - Lease
- nis
Get
Dhcp Interface List Data Server Option Nis - Nis
- ntp
Get
Dhcp Interface List Data Server Option Ntp - Ntp
- pop3_
server str - POP3 server
- smtp_
server str - SMTP server
- subnet_
mask str - Subnet mask
- user_
defineds Sequence[GetDhcp Interface List Data Server Option User Defined] - Custom DHCP options
- wins
Get
Dhcp Interface List Data Server Option Wins - Wins
- dns Property Map
- Dns
- dns
Suffix String - DNS suffix
- gateway String
- Default gateway
- inheritance Property Map
- Inheritance
- lease Property Map
- Lease
- nis Property Map
- Nis
- ntp Property Map
- Ntp
- pop3Server String
- POP3 server
- smtp
Server String - SMTP server
- subnet
Mask String - Subnet mask
- user
Defineds List<Property Map> - Custom DHCP options
- wins Property Map
- Wins
GetDhcpInterfaceListDataServerOptionDns
GetDhcpInterfaceListDataServerOptionInheritance
- Source string
- Interface from which to inherit lease options
- Source string
- Interface from which to inherit lease options
- source String
- Interface from which to inherit lease options
- source string
- Interface from which to inherit lease options
- source str
- Interface from which to inherit lease options
- source String
- Interface from which to inherit lease options
GetDhcpInterfaceListDataServerOptionLease
- Timeout int
- DHCP lease timeout (minutes)
- Unlimited
Get
Dhcp Interface List Data Server Option Lease Unlimited Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
- Timeout int
- DHCP lease timeout (minutes)
- Unlimited
Get
Dhcp Interface List Data Server Option Lease Unlimited Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
- timeout Integer
- DHCP lease timeout (minutes)
- unlimited
Get
Dhcp Interface List Data Server Option Lease Unlimited Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
- timeout number
- DHCP lease timeout (minutes)
- unlimited
Get
Dhcp Interface List Data Server Option Lease Unlimited Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
- timeout int
- DHCP lease timeout (minutes)
- unlimited
Get
Dhcp Interface List Data Server Option Lease Unlimited Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
- timeout Number
- DHCP lease timeout (minutes)
- unlimited Property Map
Unlimited
ℹ️ Note: You must specify exactly one of
timeoutandunlimited.
GetDhcpInterfaceListDataServerOptionNis
GetDhcpInterfaceListDataServerOptionNtp
GetDhcpInterfaceListDataServerOptionUserDefined
GetDhcpInterfaceListDataServerOptionWins
GetDhcpInterfaceListDataServerReserved
- Description string
- Reservation description
- Mac string
- Reserved MAC address
- Name string
- Reserved IP address
- Description string
- Reservation description
- Mac string
- Reserved MAC address
- Name string
- Reserved IP address
- description String
- Reservation description
- mac String
- Reserved MAC address
- name String
- Reserved IP address
- description string
- Reservation description
- mac string
- Reserved MAC address
- name string
- Reserved IP address
- description str
- Reservation description
- mac str
- Reserved MAC address
- name str
- Reserved IP address
- description String
- Reservation description
- mac String
- Reserved MAC address
- name String
- Reserved IP address
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
