@pulumi/openstack/networking/getPort.d.ts

A Pulumi package for creating and managing OpenStack cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get the ID of an available OpenStack port.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as openstack from "@pulumi/openstack";
 *
 * const port1 = openstack.networking.getPort({
 *     name: "port_1",
 * });
 * ```
 */
export declare function getPort(args?: GetPortArgs, opts?: pulumi.InvokeOptions): Promise<GetPortResult>;
/**
 * A collection of arguments for invoking getPort.
 */
export interface GetPortArgs {
    /**
     * The administrative state of the port.
     */
    adminStateUp?: boolean;
    /**
     * Human-readable description of the port.
     */
    description?: string;
    /**
     * The ID of the device the port belongs to.
     */
    deviceId?: string;
    /**
     * The device owner of the port.
     */
    deviceOwner?: string;
    /**
     * The port DNS name to filter. Available, when Neutron
     * DNS extension is enabled.
     */
    dnsName?: string;
    /**
     * The port IP address filter.
     */
    fixedIp?: string;
    /**
     * The MAC address of the port.
     */
    macAddress?: string;
    /**
     * The name of the port.
     */
    name?: string;
    /**
     * The ID of the network the port belongs to.
     */
    networkId?: string;
    /**
     * The ID of the port.
     */
    portId?: string;
    /**
     * The owner of the port.
     */
    projectId?: string;
    /**
     * The region in which to obtain the V2 Neutron client.
     * A Neutron client is needed to retrieve port ids. If omitted, the
     * `region` argument of the provider is used.
     */
    region?: string;
    /**
     * The list of port security group IDs to filter.
     */
    securityGroupIds?: string[];
    /**
     * The status of the port.
     */
    status?: string;
    /**
     * The list of port tags to filter.
     */
    tags?: string[];
    tenantId?: string;
}
/**
 * A collection of values returned by getPort.
 */
export interface GetPortResult {
    /**
     * See Argument Reference above.
     */
    readonly adminStateUp?: boolean;
    /**
     * The collection of Fixed IP addresses on the port in the
     * order returned by the Network v2 API.
     */
    readonly allFixedIps: string[];
    /**
     * The set of security group IDs applied on the port.
     */
    readonly allSecurityGroupIds: string[];
    /**
     * The set of string tags applied on the port.
     */
    readonly allTags: string[];
    /**
     * An IP/MAC Address pair of additional IP
     * addresses that can be active on this port. The structure is described
     * below.
     */
    readonly allowedAddressPairs: outputs.networking.GetPortAllowedAddressPair[];
    /**
     * The port binding information. The structure is described below.
     */
    readonly bindings: outputs.networking.GetPortBinding[];
    /**
     * See Argument Reference above.
     */
    readonly description?: string;
    /**
     * See Argument Reference above.
     */
    readonly deviceId?: string;
    /**
     * See Argument Reference above.
     */
    readonly deviceOwner?: string;
    /**
     * The list of maps representing port DNS assignments.
     */
    readonly dnsAssignments: {
        [key: string]: string;
    }[];
    /**
     * See Argument Reference above.
     */
    readonly dnsName?: string;
    /**
     * An extra DHCP option configured on the port.
     * The structure is described below.
     */
    readonly extraDhcpOptions: outputs.networking.GetPortExtraDhcpOption[];
    readonly fixedIp?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The additional MAC address.
     */
    readonly macAddress?: string;
    /**
     * Name of the DHCP option.
     */
    readonly name?: string;
    /**
     * See Argument Reference above.
     */
    readonly networkId?: string;
    /**
     * See Argument Reference above.
     */
    readonly portId?: string;
    /**
     * See Argument Reference above.
     */
    readonly projectId?: string;
    /**
     * See Argument Reference above.
     */
    readonly region?: string;
    readonly securityGroupIds?: string[];
    readonly status?: string;
    readonly tags?: string[];
    readonly tenantId?: string;
}
/**
 * Use this data source to get the ID of an available OpenStack port.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as openstack from "@pulumi/openstack";
 *
 * const port1 = openstack.networking.getPort({
 *     name: "port_1",
 * });
 * ```
 */
export declare function getPortOutput(args?: GetPortOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPortResult>;
/**
 * A collection of arguments for invoking getPort.
 */
export interface GetPortOutputArgs {
    /**
     * The administrative state of the port.
     */
    adminStateUp?: pulumi.Input<boolean>;
    /**
     * Human-readable description of the port.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the device the port belongs to.
     */
    deviceId?: pulumi.Input<string>;
    /**
     * The device owner of the port.
     */
    deviceOwner?: pulumi.Input<string>;
    /**
     * The port DNS name to filter. Available, when Neutron
     * DNS extension is enabled.
     */
    dnsName?: pulumi.Input<string>;
    /**
     * The port IP address filter.
     */
    fixedIp?: pulumi.Input<string>;
    /**
     * The MAC address of the port.
     */
    macAddress?: pulumi.Input<string>;
    /**
     * The name of the port.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the network the port belongs to.
     */
    networkId?: pulumi.Input<string>;
    /**
     * The ID of the port.
     */
    portId?: pulumi.Input<string>;
    /**
     * The owner of the port.
     */
    projectId?: pulumi.Input<string>;
    /**
     * The region in which to obtain the V2 Neutron client.
     * A Neutron client is needed to retrieve port ids. If omitted, the
     * `region` argument of the provider is used.
     */
    region?: pulumi.Input<string>;
    /**
     * The list of port security group IDs to filter.
     */
    securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The status of the port.
     */
    status?: pulumi.Input<string>;
    /**
     * The list of port tags to filter.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<string>;
}