Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.getAutomationaction

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Using getAutomationaction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getAutomationaction(args: GetAutomationactionArgs, opts?: InvokeOptions): Promise<GetAutomationactionResult>
function getAutomationactionOutput(args: GetAutomationactionOutputArgs, opts?: InvokeOptions): Output<GetAutomationactionResult>

def get_automationaction(name: Optional[str] = None,
                         vdomparam: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAutomationactionResult
def get_automationaction_output(name: Optional[pulumi.Input[str]] = None,
                         vdomparam: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAutomationactionResult]

func LookupAutomationaction(ctx *Context, args *LookupAutomationactionArgs, opts ...InvokeOption) (*LookupAutomationactionResult, error)
func LookupAutomationactionOutput(ctx *Context, args *LookupAutomationactionOutputArgs, opts ...InvokeOption) LookupAutomationactionResultOutput

> Note: This function is named LookupAutomationaction in the Go SDK.

public static class GetAutomationaction 
{
    public static Task<GetAutomationactionResult> InvokeAsync(GetAutomationactionArgs args, InvokeOptions? opts = null)
    public static Output<GetAutomationactionResult> Invoke(GetAutomationactionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAutomationactionResult> getAutomationaction(GetAutomationactionArgs args, InvokeOptions options)
public static Output<GetAutomationactionResult> getAutomationaction(GetAutomationactionArgs args, InvokeOptions options)

fn::invoke:
  function: fortios:system/getAutomationaction:getAutomationaction
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specify the name of the desired system automationaction.
Vdomparam string: Specifies the vdom to which the data source 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.

Name string: Specify the name of the desired system automationaction.
Vdomparam string: Specifies the vdom to which the data source 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.

name String: Specify the name of the desired system automationaction.
vdomparam String: Specifies the vdom to which the data source 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.

name string: Specify the name of the desired system automationaction.
vdomparam string: Specifies the vdom to which the data source 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.

name str: Specify the name of the desired system automationaction.
vdomparam str: Specifies the vdom to which the data source 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.

name String: Specify the name of the desired system automationaction.
vdomparam String: Specifies the vdom to which the data source 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.

getAutomationaction Result

The following output properties are available:

Accprofile string: Access profile for CLI script action to access FortiGate features.
ActionType string: Action type.
AlicloudAccessKeyId string: AliCloud AccessKey ID.
AlicloudAccessKeySecret string: AliCloud AccessKey secret.
AlicloudAccountId string: AliCloud account ID.
AlicloudFunction string: AliCloud function name.
AlicloudFunctionAuthorization string: AliCloud function authorization type.
AlicloudFunctionDomain string: AliCloud function domain.
AlicloudRegion string: AliCloud region.
AlicloudService string: AliCloud service name.
AlicloudVersion string: AliCloud version.
AwsApiId string: AWS API Gateway ID.
AwsApiKey string: AWS API Gateway API key.
AwsApiPath string: AWS API Gateway path.
AwsApiStage string: AWS API Gateway deployment stage name.
AwsDomain string: AWS domain.
AwsRegion string: AWS region.
AzureApiKey string: Azure function API key.
AzureApp string: Azure function application name.
AzureDomain string: Azure function domain.
AzureFunction string: Azure function name.
AzureFunctionAuthorization string: Azure function authorization level.
Delay int: Delay before execution (in seconds).
Description string: Description.
EmailBody string: Email body.
EmailFrom string: Email sender name.
EmailSubject string: Email subject.
EmailTos List<Pulumiverse.Fortios.System.Outputs.GetAutomationactionEmailTo>: Email addresses. The structure of email_to block is documented below.
ExecuteSecurityFabric string: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
ForticareEmail string: Enable/disable use of your FortiCare email address as the email-to address.
GcpFunction string: Google Cloud function name.
GcpFunctionDomain string: Google Cloud function domain.
GcpFunctionRegion string: Google Cloud function region.
GcpProject string: Google Cloud Platform project name.
Headers List<Pulumiverse.Fortios.System.Outputs.GetAutomationactionHeader>: Request headers. The structure of headers block is documented below.
HttpBody string: Request body (if necessary). Should be serialized json string.
HttpHeaders List<Pulumiverse.Fortios.System.Outputs.GetAutomationactionHttpHeader>: Request headers. The structure of http_headers block is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Message string: Message content.
MessageType string: Message type.
Method string: Request method (POST, PUT, GET, PATCH or DELETE).
MinimumInterval int: Limit execution to no more than once in this interval (in seconds).
Name string: SDN connector name.
OutputSize int: Number of megabytes to limit script output to (1 - 1024, default = 10).
Port int: Protocol port.
Protocol string: Request protocol.
ReplacementMessage string: Enable/disable replacement message.
ReplacemsgGroup string: Replacement message group.
Required string: Required in action chain.
Script string: CLI script.
SdnConnectors List<Pulumiverse.Fortios.System.Outputs.GetAutomationactionSdnConnector>: NSX SDN connector names. The structure of sdn_connector block is documented below.
SecurityTag string: NSX security tag.
SystemAction string: System action type.
Timeout int: Maximum running time for this script in seconds (0 = no timeout).
TlsCertificate string: Custom TLS certificate for API request.
Uri string: Request API URI.
VerifyHostCert string: Enable/disable verification of the remote host certificate.
Vdomparam string

Accprofile string: Access profile for CLI script action to access FortiGate features.
ActionType string: Action type.
AlicloudAccessKeyId string: AliCloud AccessKey ID.
AlicloudAccessKeySecret string: AliCloud AccessKey secret.
AlicloudAccountId string: AliCloud account ID.
AlicloudFunction string: AliCloud function name.
AlicloudFunctionAuthorization string: AliCloud function authorization type.
AlicloudFunctionDomain string: AliCloud function domain.
AlicloudRegion string: AliCloud region.
AlicloudService string: AliCloud service name.
AlicloudVersion string: AliCloud version.
AwsApiId string: AWS API Gateway ID.
AwsApiKey string: AWS API Gateway API key.
AwsApiPath string: AWS API Gateway path.
AwsApiStage string: AWS API Gateway deployment stage name.
AwsDomain string: AWS domain.
AwsRegion string: AWS region.
AzureApiKey string: Azure function API key.
AzureApp string: Azure function application name.
AzureDomain string: Azure function domain.
AzureFunction string: Azure function name.
AzureFunctionAuthorization string: Azure function authorization level.
Delay int: Delay before execution (in seconds).
Description string: Description.
EmailBody string: Email body.
EmailFrom string: Email sender name.
EmailSubject string: Email subject.
EmailTos []GetAutomationactionEmailTo: Email addresses. The structure of email_to block is documented below.
ExecuteSecurityFabric string: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
ForticareEmail string: Enable/disable use of your FortiCare email address as the email-to address.
GcpFunction string: Google Cloud function name.
GcpFunctionDomain string: Google Cloud function domain.
GcpFunctionRegion string: Google Cloud function region.
GcpProject string: Google Cloud Platform project name.
Headers []GetAutomationactionHeader: Request headers. The structure of headers block is documented below.
HttpBody string: Request body (if necessary). Should be serialized json string.
HttpHeaders []GetAutomationactionHttpHeader: Request headers. The structure of http_headers block is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Message string: Message content.
MessageType string: Message type.
Method string: Request method (POST, PUT, GET, PATCH or DELETE).
MinimumInterval int: Limit execution to no more than once in this interval (in seconds).
Name string: SDN connector name.
OutputSize int: Number of megabytes to limit script output to (1 - 1024, default = 10).
Port int: Protocol port.
Protocol string: Request protocol.
ReplacementMessage string: Enable/disable replacement message.
ReplacemsgGroup string: Replacement message group.
Required string: Required in action chain.
Script string: CLI script.
SdnConnectors []GetAutomationactionSdnConnector: NSX SDN connector names. The structure of sdn_connector block is documented below.
SecurityTag string: NSX security tag.
SystemAction string: System action type.
Timeout int: Maximum running time for this script in seconds (0 = no timeout).
TlsCertificate string: Custom TLS certificate for API request.
Uri string: Request API URI.
VerifyHostCert string: Enable/disable verification of the remote host certificate.
Vdomparam string

accprofile String: Access profile for CLI script action to access FortiGate features.
actionType String: Action type.
alicloudAccessKeyId String: AliCloud AccessKey ID.
alicloudAccessKeySecret String: AliCloud AccessKey secret.
alicloudAccountId String: AliCloud account ID.
alicloudFunction String: AliCloud function name.
alicloudFunctionAuthorization String: AliCloud function authorization type.
alicloudFunctionDomain String: AliCloud function domain.
alicloudRegion String: AliCloud region.
alicloudService String: AliCloud service name.
alicloudVersion String: AliCloud version.
awsApiId String: AWS API Gateway ID.
awsApiKey String: AWS API Gateway API key.
awsApiPath String: AWS API Gateway path.
awsApiStage String: AWS API Gateway deployment stage name.
awsDomain String: AWS domain.
awsRegion String: AWS region.
azureApiKey String: Azure function API key.
azureApp String: Azure function application name.
azureDomain String: Azure function domain.
azureFunction String: Azure function name.
azureFunctionAuthorization String: Azure function authorization level.
delay Integer: Delay before execution (in seconds).
description String: Description.
emailBody String: Email body.
emailFrom String: Email sender name.
emailSubject String: Email subject.
emailTos List<GetAutomationactionEmailTo>: Email addresses. The structure of email_to block is documented below.
executeSecurityFabric String: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
forticareEmail String: Enable/disable use of your FortiCare email address as the email-to address.
gcpFunction String: Google Cloud function name.
gcpFunctionDomain String: Google Cloud function domain.
gcpFunctionRegion String: Google Cloud function region.
gcpProject String: Google Cloud Platform project name.
headers List<GetAutomationactionHeader>: Request headers. The structure of headers block is documented below.
httpBody String: Request body (if necessary). Should be serialized json string.
httpHeaders List<GetAutomationactionHttpHeader>: Request headers. The structure of http_headers block is documented below.
id String: The provider-assigned unique ID for this managed resource.
message String: Message content.
messageType String: Message type.
method String: Request method (POST, PUT, GET, PATCH or DELETE).
minimumInterval Integer: Limit execution to no more than once in this interval (in seconds).
name String: SDN connector name.
outputSize Integer: Number of megabytes to limit script output to (1 - 1024, default = 10).
port Integer: Protocol port.
protocol String: Request protocol.
replacementMessage String: Enable/disable replacement message.
replacemsgGroup String: Replacement message group.
required String: Required in action chain.
script String: CLI script.
sdnConnectors List<GetAutomationactionSdnConnector>: NSX SDN connector names. The structure of sdn_connector block is documented below.
securityTag String: NSX security tag.
systemAction String: System action type.
timeout Integer: Maximum running time for this script in seconds (0 = no timeout).
tlsCertificate String: Custom TLS certificate for API request.
uri String: Request API URI.
verifyHostCert String: Enable/disable verification of the remote host certificate.
vdomparam String

accprofile string: Access profile for CLI script action to access FortiGate features.
actionType string: Action type.
alicloudAccessKeyId string: AliCloud AccessKey ID.
alicloudAccessKeySecret string: AliCloud AccessKey secret.
alicloudAccountId string: AliCloud account ID.
alicloudFunction string: AliCloud function name.
alicloudFunctionAuthorization string: AliCloud function authorization type.
alicloudFunctionDomain string: AliCloud function domain.
alicloudRegion string: AliCloud region.
alicloudService string: AliCloud service name.
alicloudVersion string: AliCloud version.
awsApiId string: AWS API Gateway ID.
awsApiKey string: AWS API Gateway API key.
awsApiPath string: AWS API Gateway path.
awsApiStage string: AWS API Gateway deployment stage name.
awsDomain string: AWS domain.
awsRegion string: AWS region.
azureApiKey string: Azure function API key.
azureApp string: Azure function application name.
azureDomain string: Azure function domain.
azureFunction string: Azure function name.
azureFunctionAuthorization string: Azure function authorization level.
delay number: Delay before execution (in seconds).
description string: Description.
emailBody string: Email body.
emailFrom string: Email sender name.
emailSubject string: Email subject.
emailTos GetAutomationactionEmailTo[]: Email addresses. The structure of email_to block is documented below.
executeSecurityFabric string: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
forticareEmail string: Enable/disable use of your FortiCare email address as the email-to address.
gcpFunction string: Google Cloud function name.
gcpFunctionDomain string: Google Cloud function domain.
gcpFunctionRegion string: Google Cloud function region.
gcpProject string: Google Cloud Platform project name.
headers GetAutomationactionHeader[]: Request headers. The structure of headers block is documented below.
httpBody string: Request body (if necessary). Should be serialized json string.
httpHeaders GetAutomationactionHttpHeader[]: Request headers. The structure of http_headers block is documented below.
id string: The provider-assigned unique ID for this managed resource.
message string: Message content.
messageType string: Message type.
method string: Request method (POST, PUT, GET, PATCH or DELETE).
minimumInterval number: Limit execution to no more than once in this interval (in seconds).
name string: SDN connector name.
outputSize number: Number of megabytes to limit script output to (1 - 1024, default = 10).
port number: Protocol port.
protocol string: Request protocol.
replacementMessage string: Enable/disable replacement message.
replacemsgGroup string: Replacement message group.
required string: Required in action chain.
script string: CLI script.
sdnConnectors GetAutomationactionSdnConnector[]: NSX SDN connector names. The structure of sdn_connector block is documented below.
securityTag string: NSX security tag.
systemAction string: System action type.
timeout number: Maximum running time for this script in seconds (0 = no timeout).
tlsCertificate string: Custom TLS certificate for API request.
uri string: Request API URI.
verifyHostCert string: Enable/disable verification of the remote host certificate.
vdomparam string

accprofile str: Access profile for CLI script action to access FortiGate features.
action_type str: Action type.
alicloud_access_key_id str: AliCloud AccessKey ID.
alicloud_access_key_secret str: AliCloud AccessKey secret.
alicloud_account_id str: AliCloud account ID.
alicloud_function str: AliCloud function name.
alicloud_function_authorization str: AliCloud function authorization type.
alicloud_function_domain str: AliCloud function domain.
alicloud_region str: AliCloud region.
alicloud_service str: AliCloud service name.
alicloud_version str: AliCloud version.
aws_api_id str: AWS API Gateway ID.
aws_api_key str: AWS API Gateway API key.
aws_api_path str: AWS API Gateway path.
aws_api_stage str: AWS API Gateway deployment stage name.
aws_domain str: AWS domain.
aws_region str: AWS region.
azure_api_key str: Azure function API key.
azure_app str: Azure function application name.
azure_domain str: Azure function domain.
azure_function str: Azure function name.
azure_function_authorization str: Azure function authorization level.
delay int: Delay before execution (in seconds).
description str: Description.
email_body str: Email body.
email_from str: Email sender name.
email_subject str: Email subject.
email_tos Sequence[GetAutomationactionEmailTo]: Email addresses. The structure of email_to block is documented below.
execute_security_fabric str: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
forticare_email str: Enable/disable use of your FortiCare email address as the email-to address.
gcp_function str: Google Cloud function name.
gcp_function_domain str: Google Cloud function domain.
gcp_function_region str: Google Cloud function region.
gcp_project str: Google Cloud Platform project name.
headers Sequence[GetAutomationactionHeader]: Request headers. The structure of headers block is documented below.
http_body str: Request body (if necessary). Should be serialized json string.
http_headers Sequence[GetAutomationactionHttpHeader]: Request headers. The structure of http_headers block is documented below.
id str: The provider-assigned unique ID for this managed resource.
message str: Message content.
message_type str: Message type.
method str: Request method (POST, PUT, GET, PATCH or DELETE).
minimum_interval int: Limit execution to no more than once in this interval (in seconds).
name str: SDN connector name.
output_size int: Number of megabytes to limit script output to (1 - 1024, default = 10).
port int: Protocol port.
protocol str: Request protocol.
replacement_message str: Enable/disable replacement message.
replacemsg_group str: Replacement message group.
required str: Required in action chain.
script str: CLI script.
sdn_connectors Sequence[GetAutomationactionSdnConnector]: NSX SDN connector names. The structure of sdn_connector block is documented below.
security_tag str: NSX security tag.
system_action str: System action type.
timeout int: Maximum running time for this script in seconds (0 = no timeout).
tls_certificate str: Custom TLS certificate for API request.
uri str: Request API URI.
verify_host_cert str: Enable/disable verification of the remote host certificate.
vdomparam str

accprofile String: Access profile for CLI script action to access FortiGate features.
actionType String: Action type.
alicloudAccessKeyId String: AliCloud AccessKey ID.
alicloudAccessKeySecret String: AliCloud AccessKey secret.
alicloudAccountId String: AliCloud account ID.
alicloudFunction String: AliCloud function name.
alicloudFunctionAuthorization String: AliCloud function authorization type.
alicloudFunctionDomain String: AliCloud function domain.
alicloudRegion String: AliCloud region.
alicloudService String: AliCloud service name.
alicloudVersion String: AliCloud version.
awsApiId String: AWS API Gateway ID.
awsApiKey String: AWS API Gateway API key.
awsApiPath String: AWS API Gateway path.
awsApiStage String: AWS API Gateway deployment stage name.
awsDomain String: AWS domain.
awsRegion String: AWS region.
azureApiKey String: Azure function API key.
azureApp String: Azure function application name.
azureDomain String: Azure function domain.
azureFunction String: Azure function name.
azureFunctionAuthorization String: Azure function authorization level.
delay Number: Delay before execution (in seconds).
description String: Description.
emailBody String: Email body.
emailFrom String: Email sender name.
emailSubject String: Email subject.
emailTos List<Property Map>: Email addresses. The structure of email_to block is documented below.
executeSecurityFabric String: Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric.
forticareEmail String: Enable/disable use of your FortiCare email address as the email-to address.
gcpFunction String: Google Cloud function name.
gcpFunctionDomain String: Google Cloud function domain.
gcpFunctionRegion String: Google Cloud function region.
gcpProject String: Google Cloud Platform project name.
headers List<Property Map>: Request headers. The structure of headers block is documented below.
httpBody String: Request body (if necessary). Should be serialized json string.
httpHeaders List<Property Map>: Request headers. The structure of http_headers block is documented below.
id String: The provider-assigned unique ID for this managed resource.
message String: Message content.
messageType String: Message type.
method String: Request method (POST, PUT, GET, PATCH or DELETE).
minimumInterval Number: Limit execution to no more than once in this interval (in seconds).
name String: SDN connector name.
outputSize Number: Number of megabytes to limit script output to (1 - 1024, default = 10).
port Number: Protocol port.
protocol String: Request protocol.
replacementMessage String: Enable/disable replacement message.
replacemsgGroup String: Replacement message group.
required String: Required in action chain.
script String: CLI script.
sdnConnectors List<Property Map>: NSX SDN connector names. The structure of sdn_connector block is documented below.
securityTag String: NSX security tag.
systemAction String: System action type.
timeout Number: Maximum running time for this script in seconds (0 = no timeout).
tlsCertificate String: Custom TLS certificate for API request.
uri String: Request API URI.
verifyHostCert String: Enable/disable verification of the remote host certificate.
vdomparam String

Supporting Types

GetAutomationactionEmailTo

Name string: Specify the name of the desired system automationaction.

Name string: Specify the name of the desired system automationaction.

name String: Specify the name of the desired system automationaction.

name string: Specify the name of the desired system automationaction.

name str: Specify the name of the desired system automationaction.

name String: Specify the name of the desired system automationaction.

GetAutomationactionHeader

Header string: Request header.

Header string: Request header.

header String: Request header.

header string: Request header.

header str: Request header.

header String: Request header.

GetAutomationactionHttpHeader

Id int: Entry ID.
Key string: Request header key.
Value string: Request header value.

Id int: Entry ID.
Key string: Request header key.
Value string: Request header value.

id Integer: Entry ID.
key String: Request header key.
value String: Request header value.

id number: Entry ID.
key string: Request header key.
value string: Request header value.

id int: Entry ID.
key str: Request header key.
value str: Request header value.

id Number: Entry ID.
key String: Request header key.
value String: Request header value.

GetAutomationactionSdnConnector

Name string: Specify the name of the desired system automationaction.

Name string: Specify the name of the desired system automationaction.

name String: Specify the name of the desired system automationaction.

name string: Specify the name of the desired system automationaction.

name str: Specify the name of the desired system automationaction.

name String: Specify the name of the desired system automationaction.

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

fortios.system.getAutomationaction

On this page

On this page

Using getAutomationaction

getAutomationaction Result

Supporting Types

GetAutomationactionEmailTo

GetAutomationactionHeader

GetAutomationactionHttpHeader

GetAutomationactionSdnConnector

Package Details

On this page

On this page