1. Packages
  2. Panos Provider
  3. API Docs
  4. LogForwardingProfile
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks

panos.LogForwardingProfile

Explore with Pulumi AI

Create LogForwardingProfile Resource

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

Constructor syntax

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

@overload
def LogForwardingProfile(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         location: Optional[LogForwardingProfileLocationArgs] = None,
                         description: Optional[str] = None,
                         disable_override: Optional[str] = None,
                         enhanced_application_logging: Optional[bool] = None,
                         match_lists: Optional[Sequence[LogForwardingProfileMatchListArgs]] = None,
                         name: Optional[str] = None)
func NewLogForwardingProfile(ctx *Context, name string, args LogForwardingProfileArgs, opts ...ResourceOption) (*LogForwardingProfile, error)
public LogForwardingProfile(string name, LogForwardingProfileArgs args, CustomResourceOptions? opts = null)
public LogForwardingProfile(String name, LogForwardingProfileArgs args)
public LogForwardingProfile(String name, LogForwardingProfileArgs args, CustomResourceOptions options)
type: panos:LogForwardingProfile
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 This property is required. LogForwardingProfileArgs
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 This property is required. LogForwardingProfileArgs
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 This property is required. LogForwardingProfileArgs
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 This property is required. LogForwardingProfileArgs
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. LogForwardingProfileArgs
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 logForwardingProfileResource = new Panos.LogForwardingProfile("logForwardingProfileResource", new()
{
    Location = new Panos.Inputs.LogForwardingProfileLocationArgs
    {
        DeviceGroup = new Panos.Inputs.LogForwardingProfileLocationDeviceGroupArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        Shared = null,
    },
    Description = "string",
    DisableOverride = "string",
    EnhancedApplicationLogging = false,
    MatchLists = new[]
    {
        new Panos.Inputs.LogForwardingProfileMatchListArgs
        {
            Name = "string",
            ActionDesc = "string",
            Actions = new[]
            {
                new Panos.Inputs.LogForwardingProfileMatchListActionArgs
                {
                    Name = "string",
                    Type = new Panos.Inputs.LogForwardingProfileMatchListActionTypeArgs
                    {
                        Integration = new Panos.Inputs.LogForwardingProfileMatchListActionTypeIntegrationArgs
                        {
                            Action = "string",
                        },
                        Tagging = new Panos.Inputs.LogForwardingProfileMatchListActionTypeTaggingArgs
                        {
                            Action = "string",
                            Registration = new Panos.Inputs.LogForwardingProfileMatchListActionTypeTaggingRegistrationArgs
                            {
                                Localhost = null,
                                Panorama = null,
                                Remote = new Panos.Inputs.LogForwardingProfileMatchListActionTypeTaggingRegistrationRemoteArgs
                                {
                                    HttpProfile = "string",
                                },
                            },
                            Tags = new[]
                            {
                                "string",
                            },
                            Target = "string",
                            Timeout = 0,
                        },
                    },
                },
            },
            Filter = "string",
            LogType = "string",
            Quarantine = false,
            SendEmails = new[]
            {
                "string",
            },
            SendHttps = new[]
            {
                "string",
            },
            SendSnmptraps = new[]
            {
                "string",
            },
            SendSyslogs = new[]
            {
                "string",
            },
            SendToPanorama = false,
        },
    },
    Name = "string",
});
Copy
example, err := panos.NewLogForwardingProfile(ctx, "logForwardingProfileResource", &panos.LogForwardingProfileArgs{
Location: &.LogForwardingProfileLocationArgs{
DeviceGroup: &.LogForwardingProfileLocationDeviceGroupArgs{
Name: pulumi.String("string"),
PanoramaDevice: pulumi.String("string"),
},
Shared: &.LogForwardingProfileLocationSharedArgs{
},
},
Description: pulumi.String("string"),
DisableOverride: pulumi.String("string"),
EnhancedApplicationLogging: pulumi.Bool(false),
MatchLists: .LogForwardingProfileMatchListArray{
&.LogForwardingProfileMatchListArgs{
Name: pulumi.String("string"),
ActionDesc: pulumi.String("string"),
Actions: .LogForwardingProfileMatchListActionArray{
&.LogForwardingProfileMatchListActionArgs{
Name: pulumi.String("string"),
Type: &.LogForwardingProfileMatchListActionTypeArgs{
Integration: &.LogForwardingProfileMatchListActionTypeIntegrationArgs{
Action: pulumi.String("string"),
},
Tagging: &.LogForwardingProfileMatchListActionTypeTaggingArgs{
Action: pulumi.String("string"),
Registration: &.LogForwardingProfileMatchListActionTypeTaggingRegistrationArgs{
Localhost: &.LogForwardingProfileMatchListActionTypeTaggingRegistrationLocalhostArgs{
},
Panorama: &.LogForwardingProfileMatchListActionTypeTaggingRegistrationPanoramaArgs{
},
Remote: &.LogForwardingProfileMatchListActionTypeTaggingRegistrationRemoteArgs{
HttpProfile: pulumi.String("string"),
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Target: pulumi.String("string"),
Timeout: pulumi.Float64(0),
},
},
},
},
Filter: pulumi.String("string"),
LogType: pulumi.String("string"),
Quarantine: pulumi.Bool(false),
SendEmails: pulumi.StringArray{
pulumi.String("string"),
},
SendHttps: pulumi.StringArray{
pulumi.String("string"),
},
SendSnmptraps: pulumi.StringArray{
pulumi.String("string"),
},
SendSyslogs: pulumi.StringArray{
pulumi.String("string"),
},
SendToPanorama: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
})
Copy
var logForwardingProfileResource = new LogForwardingProfile("logForwardingProfileResource", LogForwardingProfileArgs.builder()
    .location(LogForwardingProfileLocationArgs.builder()
        .deviceGroup(LogForwardingProfileLocationDeviceGroupArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .shared()
        .build())
    .description("string")
    .disableOverride("string")
    .enhancedApplicationLogging(false)
    .matchLists(LogForwardingProfileMatchListArgs.builder()
        .name("string")
        .actionDesc("string")
        .actions(LogForwardingProfileMatchListActionArgs.builder()
            .name("string")
            .type(LogForwardingProfileMatchListActionTypeArgs.builder()
                .integration(LogForwardingProfileMatchListActionTypeIntegrationArgs.builder()
                    .action("string")
                    .build())
                .tagging(LogForwardingProfileMatchListActionTypeTaggingArgs.builder()
                    .action("string")
                    .registration(LogForwardingProfileMatchListActionTypeTaggingRegistrationArgs.builder()
                        .localhost()
                        .panorama()
                        .remote(LogForwardingProfileMatchListActionTypeTaggingRegistrationRemoteArgs.builder()
                            .httpProfile("string")
                            .build())
                        .build())
                    .tags("string")
                    .target("string")
                    .timeout(0)
                    .build())
                .build())
            .build())
        .filter("string")
        .logType("string")
        .quarantine(false)
        .sendEmails("string")
        .sendHttps("string")
        .sendSnmptraps("string")
        .sendSyslogs("string")
        .sendToPanorama(false)
        .build())
    .name("string")
    .build());
Copy
log_forwarding_profile_resource = panos.LogForwardingProfile("logForwardingProfileResource",
    location={
        "device_group": {
            "name": "string",
            "panorama_device": "string",
        },
        "shared": {},
    },
    description="string",
    disable_override="string",
    enhanced_application_logging=False,
    match_lists=[{
        "name": "string",
        "action_desc": "string",
        "actions": [{
            "name": "string",
            "type": {
                "integration": {
                    "action": "string",
                },
                "tagging": {
                    "action": "string",
                    "registration": {
                        "localhost": {},
                        "panorama": {},
                        "remote": {
                            "http_profile": "string",
                        },
                    },
                    "tags": ["string"],
                    "target": "string",
                    "timeout": 0,
                },
            },
        }],
        "filter": "string",
        "log_type": "string",
        "quarantine": False,
        "send_emails": ["string"],
        "send_https": ["string"],
        "send_snmptraps": ["string"],
        "send_syslogs": ["string"],
        "send_to_panorama": False,
    }],
    name="string")
Copy
const logForwardingProfileResource = new panos.LogForwardingProfile("logForwardingProfileResource", {
    location: {
        deviceGroup: {
            name: "string",
            panoramaDevice: "string",
        },
        shared: {},
    },
    description: "string",
    disableOverride: "string",
    enhancedApplicationLogging: false,
    matchLists: [{
        name: "string",
        actionDesc: "string",
        actions: [{
            name: "string",
            type: {
                integration: {
                    action: "string",
                },
                tagging: {
                    action: "string",
                    registration: {
                        localhost: {},
                        panorama: {},
                        remote: {
                            httpProfile: "string",
                        },
                    },
                    tags: ["string"],
                    target: "string",
                    timeout: 0,
                },
            },
        }],
        filter: "string",
        logType: "string",
        quarantine: false,
        sendEmails: ["string"],
        sendHttps: ["string"],
        sendSnmptraps: ["string"],
        sendSyslogs: ["string"],
        sendToPanorama: false,
    }],
    name: "string",
});
Copy
type: panos:LogForwardingProfile
properties:
    description: string
    disableOverride: string
    enhancedApplicationLogging: false
    location:
        deviceGroup:
            name: string
            panoramaDevice: string
        shared: {}
    matchLists:
        - actionDesc: string
          actions:
            - name: string
              type:
                integration:
                    action: string
                tagging:
                    action: string
                    registration:
                        localhost: {}
                        panorama: {}
                        remote:
                            httpProfile: string
                    tags:
                        - string
                    target: string
                    timeout: 0
          filter: string
          logType: string
          name: string
          quarantine: false
          sendEmails:
            - string
          sendHttps:
            - string
          sendSnmptraps:
            - string
          sendSyslogs:
            - string
          sendToPanorama: false
    name: string
Copy

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

Location This property is required. LogForwardingProfileLocation
The location of this object.
Description string
DisableOverride string
disable object override in child device groups
EnhancedApplicationLogging bool
Enabling enhanced-application-logging
MatchLists List<LogForwardingProfileMatchList>
Name string
Location This property is required. LogForwardingProfileLocationArgs
The location of this object.
Description string
DisableOverride string
disable object override in child device groups
EnhancedApplicationLogging bool
Enabling enhanced-application-logging
MatchLists []LogForwardingProfileMatchListArgs
Name string
location This property is required. LogForwardingProfileLocation
The location of this object.
description String
disableOverride String
disable object override in child device groups
enhancedApplicationLogging Boolean
Enabling enhanced-application-logging
matchLists List<LogForwardingProfileMatchList>
name String
location This property is required. LogForwardingProfileLocation
The location of this object.
description string
disableOverride string
disable object override in child device groups
enhancedApplicationLogging boolean
Enabling enhanced-application-logging
matchLists LogForwardingProfileMatchList[]
name string
location This property is required. LogForwardingProfileLocationArgs
The location of this object.
description str
disable_override str
disable object override in child device groups
enhanced_application_logging bool
Enabling enhanced-application-logging
match_lists Sequence[LogForwardingProfileMatchListArgs]
name str
location This property is required. Property Map
The location of this object.
description String
disableOverride String
disable object override in child device groups
enhancedApplicationLogging Boolean
Enabling enhanced-application-logging
matchLists List<Property Map>
name String

Outputs

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

Get an existing LogForwardingProfile 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?: LogForwardingProfileState, opts?: CustomResourceOptions): LogForwardingProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_override: Optional[str] = None,
        enhanced_application_logging: Optional[bool] = None,
        location: Optional[LogForwardingProfileLocationArgs] = None,
        match_lists: Optional[Sequence[LogForwardingProfileMatchListArgs]] = None,
        name: Optional[str] = None) -> LogForwardingProfile
func GetLogForwardingProfile(ctx *Context, name string, id IDInput, state *LogForwardingProfileState, opts ...ResourceOption) (*LogForwardingProfile, error)
public static LogForwardingProfile Get(string name, Input<string> id, LogForwardingProfileState? state, CustomResourceOptions? opts = null)
public static LogForwardingProfile get(String name, Output<String> id, LogForwardingProfileState state, CustomResourceOptions options)
resources:  _:    type: panos:LogForwardingProfile    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:
Description string
DisableOverride string
disable object override in child device groups
EnhancedApplicationLogging bool
Enabling enhanced-application-logging
Location LogForwardingProfileLocation
The location of this object.
MatchLists List<LogForwardingProfileMatchList>
Name string
Description string
DisableOverride string
disable object override in child device groups
EnhancedApplicationLogging bool
Enabling enhanced-application-logging
Location LogForwardingProfileLocationArgs
The location of this object.
MatchLists []LogForwardingProfileMatchListArgs
Name string
description String
disableOverride String
disable object override in child device groups
enhancedApplicationLogging Boolean
Enabling enhanced-application-logging
location LogForwardingProfileLocation
The location of this object.
matchLists List<LogForwardingProfileMatchList>
name String
description string
disableOverride string
disable object override in child device groups
enhancedApplicationLogging boolean
Enabling enhanced-application-logging
location LogForwardingProfileLocation
The location of this object.
matchLists LogForwardingProfileMatchList[]
name string
description str
disable_override str
disable object override in child device groups
enhanced_application_logging bool
Enabling enhanced-application-logging
location LogForwardingProfileLocationArgs
The location of this object.
match_lists Sequence[LogForwardingProfileMatchListArgs]
name str
description String
disableOverride String
disable object override in child device groups
enhancedApplicationLogging Boolean
Enabling enhanced-application-logging
location Property Map
The location of this object.
matchLists List<Property Map>
name String

Supporting Types

LogForwardingProfileLocation
, LogForwardingProfileLocationArgs

deviceGroup Property Map
Located in a specific Device Group
shared Property Map
Panorama shared object

LogForwardingProfileLocationDeviceGroup
, LogForwardingProfileLocationDeviceGroupArgs

Name string
Device Group name
PanoramaDevice string
Panorama device name
Name string
Device Group name
PanoramaDevice string
Panorama device name
name String
Device Group name
panoramaDevice String
Panorama device name
name string
Device Group name
panoramaDevice string
Panorama device name
name str
Device Group name
panorama_device str
Panorama device name
name String
Device Group name
panoramaDevice String
Panorama device name

LogForwardingProfileMatchList
, LogForwardingProfileMatchListArgs

Name This property is required. string
ActionDesc string
Actions List<LogForwardingProfileMatchListAction>
Filter string
LogType string
Pick log type
Quarantine bool
SendEmails List<string>
SendHttps List<string>
SendSnmptraps List<string>
SendSyslogs List<string>
SendToPanorama bool
Name This property is required. string
ActionDesc string
Actions []LogForwardingProfileMatchListAction
Filter string
LogType string
Pick log type
Quarantine bool
SendEmails []string
SendHttps []string
SendSnmptraps []string
SendSyslogs []string
SendToPanorama bool
name This property is required. String
actionDesc String
actions List<LogForwardingProfileMatchListAction>
filter String
logType String
Pick log type
quarantine Boolean
sendEmails List<String>
sendHttps List<String>
sendSnmptraps List<String>
sendSyslogs List<String>
sendToPanorama Boolean
name This property is required. string
actionDesc string
actions LogForwardingProfileMatchListAction[]
filter string
logType string
Pick log type
quarantine boolean
sendEmails string[]
sendHttps string[]
sendSnmptraps string[]
sendSyslogs string[]
sendToPanorama boolean
name This property is required. str
action_desc str
actions Sequence[LogForwardingProfileMatchListAction]
filter str
log_type str
Pick log type
quarantine bool
send_emails Sequence[str]
send_https Sequence[str]
send_snmptraps Sequence[str]
send_syslogs Sequence[str]
send_to_panorama bool
name This property is required. String
actionDesc String
actions List<Property Map>
filter String
logType String
Pick log type
quarantine Boolean
sendEmails List<String>
sendHttps List<String>
sendSnmptraps List<String>
sendSyslogs List<String>
sendToPanorama Boolean

LogForwardingProfileMatchListAction
, LogForwardingProfileMatchListActionArgs

Name This property is required. string
Type LogForwardingProfileMatchListActionType
Name This property is required. string
Type LogForwardingProfileMatchListActionType
name This property is required. String
type LogForwardingProfileMatchListActionType
name This property is required. string
type LogForwardingProfileMatchListActionType
name This property is required. str
type LogForwardingProfileMatchListActionType
name This property is required. String
type Property Map

LogForwardingProfileMatchListActionType
, LogForwardingProfileMatchListActionTypeArgs

LogForwardingProfileMatchListActionTypeIntegration
, LogForwardingProfileMatchListActionTypeIntegrationArgs

Action string
Action string
action String
action string
action str
action String

LogForwardingProfileMatchListActionTypeTagging
, LogForwardingProfileMatchListActionTypeTaggingArgs

action String
registration Property Map
tags List<String>
target String
timeout Number
timeout in minutes

LogForwardingProfileMatchListActionTypeTaggingRegistration
, LogForwardingProfileMatchListActionTypeTaggingRegistrationArgs

LogForwardingProfileMatchListActionTypeTaggingRegistrationRemote
, LogForwardingProfileMatchListActionTypeTaggingRegistrationRemoteArgs

Package Details

Repository
panos paloaltonetworks/terraform-provider-panos
License
Notes
This Pulumi package is based on the panos Terraform Provider.