unifi.port.Profile data source can be used to retrieve port profile configurations from your UniFi network. Port profiles define settings and behaviors for switch ports, including VLANs, PoE settings, and other port-specific configurations. This data source is particularly useful when you need to reference existing port profiles in switch port configurations.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";
const all = unifi.port.getProfile({});
import pulumi
import pulumi_unifi as unifi
all = unifi.port.get_profile()
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/port"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := port.LookupProfile(ctx, &port.LookupProfileArgs{}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;
return await Deployment.RunAsync(() =>
{
var all = Unifi.Port.GetProfile.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.port.PortFunctions;
import com.pulumi.unifi.port.inputs.GetProfileArgs;
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 all = PortFunctions.getProfile(GetProfileArgs.builder()
.build());
}
}
variables:
all:
fn::invoke:
function: unifi:port:getProfile
arguments: {}
Using getProfile
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 getProfile(args: GetProfileArgs, opts?: InvokeOptions): Promise<GetProfileResult>
function getProfileOutput(args: GetProfileOutputArgs, opts?: InvokeOptions): Output<GetProfileResult>def get_profile(name: Optional[str] = None,
site: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProfileResult
def get_profile_output(name: Optional[pulumi.Input[str]] = None,
site: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProfileResult]func LookupProfile(ctx *Context, args *LookupProfileArgs, opts ...InvokeOption) (*LookupProfileResult, error)
func LookupProfileOutput(ctx *Context, args *LookupProfileOutputArgs, opts ...InvokeOption) LookupProfileResultOutput> Note: This function is named LookupProfile in the Go SDK.
public static class GetProfile
{
public static Task<GetProfileResult> InvokeAsync(GetProfileArgs args, InvokeOptions? opts = null)
public static Output<GetProfileResult> Invoke(GetProfileInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)
public static Output<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)
fn::invoke:
function: unifi:port/getProfile:getProfile
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - Site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- Name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - Site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name String
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - site String
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name str
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - site str
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name String
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All. - site String
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
getProfile Result
The following output properties are available:
- Id string
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- Site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- Name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
- Id string
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- Site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- Name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
- id String
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- site String
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name String
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
- id string
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- site string
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name string
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
- id str
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- site str
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name str
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
- id String
- The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.
- site String
- The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
- name String
- The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to
All.
Package Details
- Repository
- unifi pulumiverse/pulumi-unifi
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
unifiTerraform Provider.
