@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
346 lines (345 loc) • 10.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to configure interface settings of FortiOS.
*
* !> **Warning:** The resource will be deprecated and replaced by new resource `fortios.system.Interface`, we recommend that you use the new resource.
*
* ## Example Usage
*
* ### Loopback Interface
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const loopback1 = new fortios.networking.InterfacePort("loopback1", {
* alias: "cc1",
* allowaccess: "ping http",
* description: "description",
* ip: "23.123.33.10 255.255.255.0",
* mode: "static",
* role: "lan",
* status: "up",
* type: "loopback",
* vdom: "root",
* });
* ```
*
* ### VLAN Interface
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const vlan1 = new fortios.networking.InterfacePort("vlan1", {
* allowaccess: "ping",
* defaultgw: "enable",
* distance: "33",
* "interface": "port2",
* ip: "3.123.33.10 255.255.255.0",
* mode: "static",
* role: "lan",
* type: "vlan",
* vdom: "root",
* vlanid: "3",
* });
* ```
*
* ### Physical Interface
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const test1 = new fortios.networking.InterfacePort("test1", {
* alias: "dkeeew",
* allowaccess: "ping https",
* defaultgw: "enable",
* description: "description",
* deviceIdentification: "enable",
* distance: "33",
* dnsServerOverride: "enable",
* ip: "93.133.133.110 255.255.255.0",
* mode: "static",
* mtu: "2933",
* mtuOverride: "enable",
* role: "lan",
* speed: "auto",
* status: "up",
* tcpMss: "3232",
* type: "physical",
* });
* ```
*/
export declare class InterfacePort extends pulumi.CustomResource {
/**
* Get an existing InterfacePort resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InterfacePortState, opts?: pulumi.CustomResourceOptions): InterfacePort;
/**
* Returns true if the given object is an instance of InterfacePort. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is InterfacePort;
/**
* Alias will be displayed with the interface name to make it easier to distinguish.
*/
readonly alias: pulumi.Output<string>;
/**
* Permitted types of management access to this interface.
*/
readonly allowaccess: pulumi.Output<string>;
/**
* Enable to get the gateway IP from the DHCP or PPPoE server.
*/
readonly defaultgw: pulumi.Output<string>;
/**
* Description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
*/
readonly deviceIdentification: pulumi.Output<string>;
/**
* Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
*/
readonly distance: pulumi.Output<string>;
/**
* Enable/disable use DNS acquired by DHCP or PPPoE.
*/
readonly dnsServerOverride: pulumi.Output<string>;
/**
* Interface name.
*/
readonly interface: pulumi.Output<string>;
/**
* Interface IPv4 address and subnet mask, syntax` - X.X.X.X X.X.X.X.
*/
readonly ip: pulumi.Output<string>;
/**
* Addressing mode.
*/
readonly mode: pulumi.Output<string>;
/**
* MTU value for this interface.
*/
readonly mtu: pulumi.Output<string>;
/**
* Enable to set a custom MTU for this interface.
*/
readonly mtuOverride: pulumi.Output<string>;
/**
* Name.
*/
readonly name: pulumi.Output<string>;
/**
* Interface role.
*/
readonly role: pulumi.Output<string>;
/**
* Interface speed. The default setting and the options available depend on the interface hardware.
*/
readonly speed: pulumi.Output<string>;
/**
* Bring the interface up or shut the interface down.
*/
readonly status: pulumi.Output<string>;
/**
* TCP maximum segment size. 0 means do not change segment size.
*/
readonly tcpMss: pulumi.Output<string>;
/**
* Interface type (support physical, vlan, loopback).
*/
readonly type: pulumi.Output<string>;
/**
* Interface is in this virtual domain (VDOM).
*/
readonly vdom: pulumi.Output<string>;
/**
* VLAN ID.
*/
readonly vlanid: pulumi.Output<string>;
/**
* Create a InterfacePort resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: InterfacePortArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InterfacePort resources.
*/
export interface InterfacePortState {
/**
* Alias will be displayed with the interface name to make it easier to distinguish.
*/
alias?: pulumi.Input<string>;
/**
* Permitted types of management access to this interface.
*/
allowaccess?: pulumi.Input<string>;
/**
* Enable to get the gateway IP from the DHCP or PPPoE server.
*/
defaultgw?: pulumi.Input<string>;
/**
* Description.
*/
description?: pulumi.Input<string>;
/**
* Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
*/
deviceIdentification?: pulumi.Input<string>;
/**
* Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
*/
distance?: pulumi.Input<string>;
/**
* Enable/disable use DNS acquired by DHCP or PPPoE.
*/
dnsServerOverride?: pulumi.Input<string>;
/**
* Interface name.
*/
interface?: pulumi.Input<string>;
/**
* Interface IPv4 address and subnet mask, syntax` - X.X.X.X X.X.X.X.
*/
ip?: pulumi.Input<string>;
/**
* Addressing mode.
*/
mode?: pulumi.Input<string>;
/**
* MTU value for this interface.
*/
mtu?: pulumi.Input<string>;
/**
* Enable to set a custom MTU for this interface.
*/
mtuOverride?: pulumi.Input<string>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Interface role.
*/
role?: pulumi.Input<string>;
/**
* Interface speed. The default setting and the options available depend on the interface hardware.
*/
speed?: pulumi.Input<string>;
/**
* Bring the interface up or shut the interface down.
*/
status?: pulumi.Input<string>;
/**
* TCP maximum segment size. 0 means do not change segment size.
*/
tcpMss?: pulumi.Input<string>;
/**
* Interface type (support physical, vlan, loopback).
*/
type?: pulumi.Input<string>;
/**
* Interface is in this virtual domain (VDOM).
*/
vdom?: pulumi.Input<string>;
/**
* VLAN ID.
*/
vlanid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InterfacePort resource.
*/
export interface InterfacePortArgs {
/**
* Alias will be displayed with the interface name to make it easier to distinguish.
*/
alias?: pulumi.Input<string>;
/**
* Permitted types of management access to this interface.
*/
allowaccess?: pulumi.Input<string>;
/**
* Enable to get the gateway IP from the DHCP or PPPoE server.
*/
defaultgw?: pulumi.Input<string>;
/**
* Description.
*/
description?: pulumi.Input<string>;
/**
* Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
*/
deviceIdentification?: pulumi.Input<string>;
/**
* Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
*/
distance?: pulumi.Input<string>;
/**
* Enable/disable use DNS acquired by DHCP or PPPoE.
*/
dnsServerOverride?: pulumi.Input<string>;
/**
* Interface name.
*/
interface?: pulumi.Input<string>;
/**
* Interface IPv4 address and subnet mask, syntax` - X.X.X.X X.X.X.X.
*/
ip?: pulumi.Input<string>;
/**
* Addressing mode.
*/
mode?: pulumi.Input<string>;
/**
* MTU value for this interface.
*/
mtu?: pulumi.Input<string>;
/**
* Enable to set a custom MTU for this interface.
*/
mtuOverride?: pulumi.Input<string>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Interface role.
*/
role?: pulumi.Input<string>;
/**
* Interface speed. The default setting and the options available depend on the interface hardware.
*/
speed?: pulumi.Input<string>;
/**
* Bring the interface up or shut the interface down.
*/
status?: pulumi.Input<string>;
/**
* TCP maximum segment size. 0 means do not change segment size.
*/
tcpMss?: pulumi.Input<string>;
/**
* Interface type (support physical, vlan, loopback).
*/
type: pulumi.Input<string>;
/**
* Interface is in this virtual domain (VDOM).
*/
vdom?: pulumi.Input<string>;
/**
* VLAN ID.
*/
vlanid?: pulumi.Input<string>;
}