Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Portpolicy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.switchcontroller.Portpolicy

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Configure port policy to be applied on the managed FortiSwitch ports through NAC device. Applies to FortiOS Version 6.4.0,6.4.1,6.4.2,6.4.10,6.4.11,6.4.12,6.4.13,6.4.14,6.4.15,7.0.0.

Create Portpolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Portpolicy(name: string, args?: PortpolicyArgs, opts?: CustomResourceOptions);
@overload
def Portpolicy(resource_name: str,
               args: Optional[PortpolicyArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Portpolicy(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bounce_port_link: Optional[str] = None,
               description: Optional[str] = None,
               fortilink: Optional[str] = None,
               lldp_profile: Optional[str] = None,
               n8021x: Optional[str] = None,
               name: Optional[str] = None,
               qos_policy: Optional[str] = None,
               vdomparam: Optional[str] = None,
               vlan_policy: Optional[str] = None)
func NewPortpolicy(ctx *Context, name string, args *PortpolicyArgs, opts ...ResourceOption) (*Portpolicy, error)
public Portpolicy(string name, PortpolicyArgs? args = null, CustomResourceOptions? opts = null)
public Portpolicy(String name, PortpolicyArgs args)
public Portpolicy(String name, PortpolicyArgs args, CustomResourceOptions options)

type: fortios:switchcontroller:Portpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args PortpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args PortpolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args PortpolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args PortpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PortpolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var portpolicyResource = new Fortios.Switchcontroller.Portpolicy("portpolicyResource", new()
{
    BouncePortLink = "string",
    Description = "string",
    Fortilink = "string",
    LldpProfile = "string",
    N8021x = "string",
    Name = "string",
    QosPolicy = "string",
    Vdomparam = "string",
    VlanPolicy = "string",
});
Copy
example, err := switchcontroller.NewPortpolicy(ctx, "portpolicyResource", &switchcontroller.PortpolicyArgs{
	BouncePortLink: pulumi.String("string"),
	Description:    pulumi.String("string"),
	Fortilink:      pulumi.String("string"),
	LldpProfile:    pulumi.String("string"),
	N8021x:         pulumi.String("string"),
	Name:           pulumi.String("string"),
	QosPolicy:      pulumi.String("string"),
	Vdomparam:      pulumi.String("string"),
	VlanPolicy:     pulumi.String("string"),
})
Copy
var portpolicyResource = new Portpolicy("portpolicyResource", PortpolicyArgs.builder()
    .bouncePortLink("string")
    .description("string")
    .fortilink("string")
    .lldpProfile("string")
    .n8021x("string")
    .name("string")
    .qosPolicy("string")
    .vdomparam("string")
    .vlanPolicy("string")
    .build());
Copy
portpolicy_resource = fortios.switchcontroller.Portpolicy("portpolicyResource",
    bounce_port_link="string",
    description="string",
    fortilink="string",
    lldp_profile="string",
    n8021x="string",
    name="string",
    qos_policy="string",
    vdomparam="string",
    vlan_policy="string")
Copy
const portpolicyResource = new fortios.switchcontroller.Portpolicy("portpolicyResource", {
    bouncePortLink: "string",
    description: "string",
    fortilink: "string",
    lldpProfile: "string",
    n8021x: "string",
    name: "string",
    qosPolicy: "string",
    vdomparam: "string",
    vlanPolicy: "string",
});
Copy
type: fortios:switchcontroller:Portpolicy
properties:
    bouncePortLink: string
    description: string
    fortilink: string
    lldpProfile: string
    n8021x: string
    name: string
    qosPolicy: string
    vdomparam: string
    vlanPolicy: string
Copy

Portpolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Portpolicy resource accepts the following input properties:

BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
Description string
Description for the port policy.
Fortilink string
FortiLink interface for which this port policy belongs to.
LldpProfile string
LLDP profile to be applied when using this port-policy.
N8021x string
802.1x security policy to be applied when using this port-policy.
Name Changes to this property will trigger replacement. string
Port policy name.
QosPolicy string
QoS policy to be applied when using this port-policy.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
VlanPolicy string
VLAN policy to be applied when using this port-policy.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
Description string
Description for the port policy.
Fortilink string
FortiLink interface for which this port policy belongs to.
LldpProfile string
LLDP profile to be applied when using this port-policy.
N8021x string
802.1x security policy to be applied when using this port-policy.
Name Changes to this property will trigger replacement. string
Port policy name.
QosPolicy string
QoS policy to be applied when using this port-policy.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
VlanPolicy string
VLAN policy to be applied when using this port-policy.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description String
Description for the port policy.
fortilink String
FortiLink interface for which this port policy belongs to.
lldpProfile String
LLDP profile to be applied when using this port-policy.
n8021x String
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. String
Port policy name.
qosPolicy String
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy String
VLAN policy to be applied when using this port-policy.
bouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description string
Description for the port policy.
fortilink string
FortiLink interface for which this port policy belongs to.
lldpProfile string
LLDP profile to be applied when using this port-policy.
n8021x string
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. string
Port policy name.
qosPolicy string
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy string
VLAN policy to be applied when using this port-policy.
bounce_port_link str
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description str
Description for the port policy.
fortilink str
FortiLink interface for which this port policy belongs to.
lldp_profile str
LLDP profile to be applied when using this port-policy.
n8021x str
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. str
Port policy name.
qos_policy str
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan_policy str
VLAN policy to be applied when using this port-policy.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description String
Description for the port policy.
fortilink String
FortiLink interface for which this port policy belongs to.
lldpProfile String
LLDP profile to be applied when using this port-policy.
n8021x String
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. String
Port policy name.
qosPolicy String
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy String
VLAN policy to be applied when using this port-policy.

Outputs

All input properties are implicitly available as output properties. Additionally, the Portpolicy resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Portpolicy Resource

Get an existing Portpolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PortpolicyState, opts?: CustomResourceOptions): Portpolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bounce_port_link: Optional[str] = None,
        description: Optional[str] = None,
        fortilink: Optional[str] = None,
        lldp_profile: Optional[str] = None,
        n8021x: Optional[str] = None,
        name: Optional[str] = None,
        qos_policy: Optional[str] = None,
        vdomparam: Optional[str] = None,
        vlan_policy: Optional[str] = None) -> Portpolicy
func GetPortpolicy(ctx *Context, name string, id IDInput, state *PortpolicyState, opts ...ResourceOption) (*Portpolicy, error)
public static Portpolicy Get(string name, Input<string> id, PortpolicyState? state, CustomResourceOptions? opts = null)
public static Portpolicy get(String name, Output<String> id, PortpolicyState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Portpolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
Description string
Description for the port policy.
Fortilink string
FortiLink interface for which this port policy belongs to.
LldpProfile string
LLDP profile to be applied when using this port-policy.
N8021x string
802.1x security policy to be applied when using this port-policy.
Name Changes to this property will trigger replacement. string
Port policy name.
QosPolicy string
QoS policy to be applied when using this port-policy.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
VlanPolicy string
VLAN policy to be applied when using this port-policy.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
Description string
Description for the port policy.
Fortilink string
FortiLink interface for which this port policy belongs to.
LldpProfile string
LLDP profile to be applied when using this port-policy.
N8021x string
802.1x security policy to be applied when using this port-policy.
Name Changes to this property will trigger replacement. string
Port policy name.
QosPolicy string
QoS policy to be applied when using this port-policy.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
VlanPolicy string
VLAN policy to be applied when using this port-policy.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description String
Description for the port policy.
fortilink String
FortiLink interface for which this port policy belongs to.
lldpProfile String
LLDP profile to be applied when using this port-policy.
n8021x String
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. String
Port policy name.
qosPolicy String
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy String
VLAN policy to be applied when using this port-policy.
bouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description string
Description for the port policy.
fortilink string
FortiLink interface for which this port policy belongs to.
lldpProfile string
LLDP profile to be applied when using this port-policy.
n8021x string
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. string
Port policy name.
qosPolicy string
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy string
VLAN policy to be applied when using this port-policy.
bounce_port_link str
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description str
Description for the port policy.
fortilink str
FortiLink interface for which this port policy belongs to.
lldp_profile str
LLDP profile to be applied when using this port-policy.
n8021x str
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. str
Port policy name.
qos_policy str
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlan_policy str
VLAN policy to be applied when using this port-policy.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile. Valid values: disable, enable.
description String
Description for the port policy.
fortilink String
FortiLink interface for which this port policy belongs to.
lldpProfile String
LLDP profile to be applied when using this port-policy.
n8021x String
802.1x security policy to be applied when using this port-policy.
name Changes to this property will trigger replacement. String
Port policy name.
qosPolicy String
QoS policy to be applied when using this port-policy.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
vlanPolicy String
VLAN policy to be applied when using this port-policy.

Import

SwitchController PortPolicy can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/portpolicy:Portpolicy labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/portpolicy:Portpolicy labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios