Docs
PackagesFortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
fortios.system.Fortiai
Explore with Pulumi AI
Configure FortiAI. Applies to FortiOS Version 7.0.1,7.0.2,7.0.3,7.0.4,7.0.5,7.0.6,7.0.7.
Create Fortiai Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fortiai(name: string, args?: FortiaiArgs, opts?: CustomResourceOptions);@overload
def Fortiai(resource_name: str,
args: Optional[FortiaiArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Fortiai(resource_name: str,
opts: Optional[ResourceOptions] = None,
interface: Optional[str] = None,
interface_select_method: Optional[str] = None,
source_ip: Optional[str] = None,
status: Optional[str] = None,
vdomparam: Optional[str] = None)func NewFortiai(ctx *Context, name string, args *FortiaiArgs, opts ...ResourceOption) (*Fortiai, error)public Fortiai(string name, FortiaiArgs? args = null, CustomResourceOptions? opts = null)
public Fortiai(String name, FortiaiArgs args)
public Fortiai(String name, FortiaiArgs args, CustomResourceOptions options)
type: fortios:system:Fortiai
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FortiaiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FortiaiArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FortiaiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FortiaiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FortiaiArgs
- 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 fortiaiResource = new Fortios.System.Fortiai("fortiaiResource", new()
{
Interface = "string",
InterfaceSelectMethod = "string",
SourceIp = "string",
Status = "string",
Vdomparam = "string",
});
example, err := system.NewFortiai(ctx, "fortiaiResource", &system.FortiaiArgs{
Interface: pulumi.String("string"),
InterfaceSelectMethod: pulumi.String("string"),
SourceIp: pulumi.String("string"),
Status: pulumi.String("string"),
Vdomparam: pulumi.String("string"),
})
var fortiaiResource = new Fortiai("fortiaiResource", FortiaiArgs.builder()
.interface_("string")
.interfaceSelectMethod("string")
.sourceIp("string")
.status("string")
.vdomparam("string")
.build());
fortiai_resource = fortios.system.Fortiai("fortiaiResource",
interface="string",
interface_select_method="string",
source_ip="string",
status="string",
vdomparam="string")
const fortiaiResource = new fortios.system.Fortiai("fortiaiResource", {
"interface": "string",
interfaceSelectMethod: "string",
sourceIp: "string",
status: "string",
vdomparam: "string",
});
type: fortios:system:Fortiai
properties:
interface: string
interfaceSelectMethod: string
sourceIp: string
status: string
vdomparam: string
Fortiai Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Fortiai resource accepts the following input properties:
- Interface string
- Specify outgoing interface to reach server.
- Interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - Source
Ip string - Source IP address for communications to FortiAI.
- Status string
- Enable/disable FortiAI. Valid values:
disable,enable. - Vdomparam 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.
- Interface string
- Specify outgoing interface to reach server.
- Interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - Source
Ip string - Source IP address for communications to FortiAI.
- Status string
- Enable/disable FortiAI. Valid values:
disable,enable. - Vdomparam 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.
- interface
Select StringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - interface_ String
- Specify outgoing interface to reach server.
- source
Ip String - Source IP address for communications to FortiAI.
- status String
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface string
- Specify outgoing interface to reach server.
- interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source
Ip string - Source IP address for communications to FortiAI.
- status string
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface str
- Specify outgoing interface to reach server.
- interface_
select_ strmethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source_
ip str - Source IP address for communications to FortiAI.
- status str
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface String
- Specify outgoing interface to reach server.
- interface
Select StringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source
Ip String - Source IP address for communications to FortiAI.
- status String
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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 Fortiai 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 Fortiai Resource
Get an existing Fortiai 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?: FortiaiState, opts?: CustomResourceOptions): Fortiai@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
interface: Optional[str] = None,
interface_select_method: Optional[str] = None,
source_ip: Optional[str] = None,
status: Optional[str] = None,
vdomparam: Optional[str] = None) -> Fortiaifunc GetFortiai(ctx *Context, name string, id IDInput, state *FortiaiState, opts ...ResourceOption) (*Fortiai, error)public static Fortiai Get(string name, Input<string> id, FortiaiState? state, CustomResourceOptions? opts = null)public static Fortiai get(String name, Output<String> id, FortiaiState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Interface string
- Specify outgoing interface to reach server.
- Interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - Source
Ip string - Source IP address for communications to FortiAI.
- Status string
- Enable/disable FortiAI. Valid values:
disable,enable. - Vdomparam 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.
- Interface string
- Specify outgoing interface to reach server.
- Interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - Source
Ip string - Source IP address for communications to FortiAI.
- Status string
- Enable/disable FortiAI. Valid values:
disable,enable. - Vdomparam 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.
- interface
Select StringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - interface_ String
- Specify outgoing interface to reach server.
- source
Ip String - Source IP address for communications to FortiAI.
- status String
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface string
- Specify outgoing interface to reach server.
- interface
Select stringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source
Ip string - Source IP address for communications to FortiAI.
- status string
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface str
- Specify outgoing interface to reach server.
- interface_
select_ strmethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source_
ip str - Source IP address for communications to FortiAI.
- status str
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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.
- interface String
- Specify outgoing interface to reach server.
- interface
Select StringMethod - Specify how to select outgoing interface to reach server. Valid values:
auto,sdwan,specify. - source
Ip String - Source IP address for communications to FortiAI.
- status String
- Enable/disable FortiAI. Valid values:
disable,enable. - vdomparam 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
System Fortiai can be imported using any of these accepted formats:
$ pulumi import fortios:system/fortiai:Fortiai labelname SystemFortiai
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:system/fortiai:Fortiai labelname SystemFortiai
$ 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
fortiosTerraform Provider.