1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. switchcontroller/autoconfig
  6. Policy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller/autoconfig.Policy

Explore with Pulumi AI

Configure FortiSwitch Auto-Config QoS policy.

Create Policy Resource

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

Constructor syntax

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

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           igmp_flood_report: Optional[str] = None,
           igmp_flood_traffic: Optional[str] = None,
           name: Optional[str] = None,
           poe_status: Optional[str] = None,
           qos_policy: Optional[str] = None,
           storm_control_policy: Optional[str] = None,
           vdomparam: Optional[str] = None)
func NewPolicy(ctx *Context, name string, args *PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs? args = null, CustomResourceOptions? opts = null)
public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)
type: fortios:switchcontroller/autoconfig/policy:Policy
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 PolicyArgs
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 PolicyArgs
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 PolicyArgs
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 PolicyArgs
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. PolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Policy 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 Policy resource accepts the following input properties:

IgmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
IgmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
PoeStatus string
Enable/disable PoE status. Valid values: enable, disable.
QosPolicy string
Auto-Config QoS policy.
StormControlPolicy string
Auto-Config storm control 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.
IgmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
IgmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
PoeStatus string
Enable/disable PoE status. Valid values: enable, disable.
QosPolicy string
Auto-Config QoS policy.
StormControlPolicy string
Auto-Config storm control 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.
igmpFloodReport String
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic String
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
Auto-Config QoS policy name
poeStatus String
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy String
Auto-Config QoS policy.
stormControlPolicy String
Auto-Config storm control 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.
igmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
poeStatus string
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy string
Auto-Config QoS policy.
stormControlPolicy string
Auto-Config storm control 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.
igmp_flood_report str
Enable/disable IGMP flood report. Valid values: enable, disable.
igmp_flood_traffic str
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. str
Auto-Config QoS policy name
poe_status str
Enable/disable PoE status. Valid values: enable, disable.
qos_policy str
Auto-Config QoS policy.
storm_control_policy str
Auto-Config storm control 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.
igmpFloodReport String
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic String
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
Auto-Config QoS policy name
poeStatus String
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy String
Auto-Config QoS policy.
stormControlPolicy String
Auto-Config storm control 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Policy 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 Policy Resource

Get an existing Policy 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?: PolicyState, opts?: CustomResourceOptions): Policy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        igmp_flood_report: Optional[str] = None,
        igmp_flood_traffic: Optional[str] = None,
        name: Optional[str] = None,
        poe_status: Optional[str] = None,
        qos_policy: Optional[str] = None,
        storm_control_policy: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Policy
func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller/autoconfig/policy:Policy    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:
IgmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
IgmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
PoeStatus string
Enable/disable PoE status. Valid values: enable, disable.
QosPolicy string
Auto-Config QoS policy.
StormControlPolicy string
Auto-Config storm control 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.
IgmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
IgmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
PoeStatus string
Enable/disable PoE status. Valid values: enable, disable.
QosPolicy string
Auto-Config QoS policy.
StormControlPolicy string
Auto-Config storm control 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.
igmpFloodReport String
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic String
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
Auto-Config QoS policy name
poeStatus String
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy String
Auto-Config QoS policy.
stormControlPolicy String
Auto-Config storm control 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.
igmpFloodReport string
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic string
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. string
Auto-Config QoS policy name
poeStatus string
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy string
Auto-Config QoS policy.
stormControlPolicy string
Auto-Config storm control 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.
igmp_flood_report str
Enable/disable IGMP flood report. Valid values: enable, disable.
igmp_flood_traffic str
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. str
Auto-Config QoS policy name
poe_status str
Enable/disable PoE status. Valid values: enable, disable.
qos_policy str
Auto-Config QoS policy.
storm_control_policy str
Auto-Config storm control 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.
igmpFloodReport String
Enable/disable IGMP flood report. Valid values: enable, disable.
igmpFloodTraffic String
Enable/disable IGMP flood traffic. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
Auto-Config QoS policy name
poeStatus String
Enable/disable PoE status. Valid values: enable, disable.
qosPolicy String
Auto-Config QoS policy.
stormControlPolicy String
Auto-Config storm control 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.

Import

SwitchControllerAutoConfig Policy can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/autoconfig/policy:Policy labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/autoconfig/policy:Policy 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.