EmailServerProfile

panos 2.0.11, Apr 28 26

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks

paloaltonetworks/terraform-provider-panos

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks

paloaltonetworks/terraform-provider-panos

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as panos from "@pulumi/panos";

const example = new panos.Template("example", {
    location: {
        panorama: {},
    },
    name: "example-template",
});
// Email server profile forwarding security logs to a corporate SMTP relay
// with authenticated SMTP and custom log format strings.
const exampleEmailServerProfile = new panos.EmailServerProfile("example", {
    location: {
        template: {
            name: example.name,
        },
    },
    name: "security-alerts-email",
    servers: [{
        name: "corporate-smtp",
        displayName: "Corporate SMTP Relay",
        from: "panos-alerts@corp.example.com",
        to: "security-team@corp.example.com",
        andAlsoTo: "noc@corp.example.com",
        gateway: "smtp.corp.example.com",
        protocol: "SMTP",
        port: 587,
        authenticationType: "Login",
        username: "panos-svc",
        password: "Str0ngP@ssw0rd!",
    }],
    format: {
        traffic: "$receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action",
        threat: "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity",
        system: "$receive_time,$serial,$type,$subtype,$severity,$opaque",
        url: "$receive_time,$serial,$type,$subtype,$src,$dst,$url",
        wildfire: "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype",
        escaping: {
            escapeCharacter: "\\",
            escapedCharacters: "\"",
        },
    },
});

import pulumi
import pulumi_panos as panos

example = panos.Template("example",
    location={
        "panorama": {},
    },
    name="example-template")
# Email server profile forwarding security logs to a corporate SMTP relay
# with authenticated SMTP and custom log format strings.
example_email_server_profile = panos.EmailServerProfile("example",
    location={
        "template": {
            "name": example.name,
        },
    },
    name="security-alerts-email",
    servers=[{
        "name": "corporate-smtp",
        "display_name": "Corporate SMTP Relay",
        "from_": "panos-alerts@corp.example.com",
        "to": "security-team@corp.example.com",
        "and_also_to": "noc@corp.example.com",
        "gateway": "smtp.corp.example.com",
        "protocol": "SMTP",
        "port": 587,
        "authentication_type": "Login",
        "username": "panos-svc",
        "password": "Str0ngP@ssw0rd!",
    }],
    format={
        "traffic": "$receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action",
        "threat": "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity",
        "system": "$receive_time,$serial,$type,$subtype,$severity,$opaque",
        "url": "$receive_time,$serial,$type,$subtype,$src,$dst,$url",
        "wildfire": "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype",
        "escaping": {
            "escape_character": "\\",
            "escaped_characters": "\"",
        },
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/panos/v2/panos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := panos.NewTemplate(ctx, "example", &panos.TemplateArgs{
			Location: &panos.TemplateLocationArgs{
				Panorama: &panos.TemplateLocationPanoramaArgs{},
			},
			Name: pulumi.String("example-template"),
		})
		if err != nil {
			return err
		}
		// Email server profile forwarding security logs to a corporate SMTP relay
		// with authenticated SMTP and custom log format strings.
		_, err = panos.NewEmailServerProfile(ctx, "example", &panos.EmailServerProfileArgs{
			Location: &panos.EmailServerProfileLocationArgs{
				Template: &panos.EmailServerProfileLocationTemplateArgs{
					Name: example.Name,
				},
			},
			Name: pulumi.String("security-alerts-email"),
			Servers: panos.EmailServerProfileServerArray{
				&panos.EmailServerProfileServerArgs{
					Name:               pulumi.String("corporate-smtp"),
					DisplayName:        pulumi.String("Corporate SMTP Relay"),
					From:               pulumi.String("panos-alerts@corp.example.com"),
					To:                 pulumi.String("security-team@corp.example.com"),
					AndAlsoTo:          pulumi.String("noc@corp.example.com"),
					Gateway:            pulumi.String("smtp.corp.example.com"),
					Protocol:           pulumi.String("SMTP"),
					Port:               pulumi.Float64(587),
					AuthenticationType: pulumi.String("Login"),
					Username:           pulumi.String("panos-svc"),
					Password:           pulumi.String("Str0ngP@ssw0rd!"),
				},
			},
			Format: &panos.EmailServerProfileFormatArgs{
				Traffic:  pulumi.String("$receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action"),
				Threat:   pulumi.String("$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity"),
				System:   pulumi.String("$receive_time,$serial,$type,$subtype,$severity,$opaque"),
				Url:      pulumi.String("$receive_time,$serial,$type,$subtype,$src,$dst,$url"),
				Wildfire: pulumi.String("$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype"),
				Escaping: &panos.EmailServerProfileFormatEscapingArgs{
					EscapeCharacter:   pulumi.String("\\"),
					EscapedCharacters: pulumi.String("\""),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Panos = Pulumi.Panos;

return await Deployment.RunAsync(() => 
{
    var example = new Panos.Template("example", new()
    {
        Location = new Panos.Inputs.TemplateLocationArgs
        {
            Panorama = null,
        },
        Name = "example-template",
    });

    // Email server profile forwarding security logs to a corporate SMTP relay
    // with authenticated SMTP and custom log format strings.
    var exampleEmailServerProfile = new Panos.EmailServerProfile("example", new()
    {
        Location = new Panos.Inputs.EmailServerProfileLocationArgs
        {
            Template = new Panos.Inputs.EmailServerProfileLocationTemplateArgs
            {
                Name = example.Name,
            },
        },
        Name = "security-alerts-email",
        Servers = new[]
        {
            new Panos.Inputs.EmailServerProfileServerArgs
            {
                Name = "corporate-smtp",
                DisplayName = "Corporate SMTP Relay",
                From = "panos-alerts@corp.example.com",
                To = "security-team@corp.example.com",
                AndAlsoTo = "noc@corp.example.com",
                Gateway = "smtp.corp.example.com",
                Protocol = "SMTP",
                Port = 587,
                AuthenticationType = "Login",
                Username = "panos-svc",
                Password = "Str0ngP@ssw0rd!",
            },
        },
        Format = new Panos.Inputs.EmailServerProfileFormatArgs
        {
            Traffic = "$receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action",
            Threat = "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity",
            System = "$receive_time,$serial,$type,$subtype,$severity,$opaque",
            Url = "$receive_time,$serial,$type,$subtype,$src,$dst,$url",
            Wildfire = "$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype",
            Escaping = new Panos.Inputs.EmailServerProfileFormatEscapingArgs
            {
                EscapeCharacter = "\\",
                EscapedCharacters = "\"",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.panos.Template;
import com.pulumi.panos.TemplateArgs;
import com.pulumi.panos.inputs.TemplateLocationArgs;
import com.pulumi.panos.inputs.TemplateLocationPanoramaArgs;
import com.pulumi.panos.EmailServerProfile;
import com.pulumi.panos.EmailServerProfileArgs;
import com.pulumi.panos.inputs.EmailServerProfileLocationArgs;
import com.pulumi.panos.inputs.EmailServerProfileLocationTemplateArgs;
import com.pulumi.panos.inputs.EmailServerProfileServerArgs;
import com.pulumi.panos.inputs.EmailServerProfileFormatArgs;
import com.pulumi.panos.inputs.EmailServerProfileFormatEscapingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Template("example", TemplateArgs.builder()
            .location(TemplateLocationArgs.builder()
                .panorama(TemplateLocationPanoramaArgs.builder()
                    .build())
                .build())
            .name("example-template")
            .build());

        // Email server profile forwarding security logs to a corporate SMTP relay
        // with authenticated SMTP and custom log format strings.
        var exampleEmailServerProfile = new EmailServerProfile("exampleEmailServerProfile", EmailServerProfileArgs.builder()
            .location(EmailServerProfileLocationArgs.builder()
                .template(EmailServerProfileLocationTemplateArgs.builder()
                    .name(example.name())
                    .build())
                .build())
            .name("security-alerts-email")
            .servers(EmailServerProfileServerArgs.builder()
                .name("corporate-smtp")
                .displayName("Corporate SMTP Relay")
                .from("panos-alerts@corp.example.com")
                .to("security-team@corp.example.com")
                .andAlsoTo("noc@corp.example.com")
                .gateway("smtp.corp.example.com")
                .protocol("SMTP")
                .port(587.0)
                .authenticationType("Login")
                .username("panos-svc")
                .password("Str0ngP@ssw0rd!")
                .build())
            .format(EmailServerProfileFormatArgs.builder()
                .traffic("$receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action")
                .threat("$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity")
                .system("$receive_time,$serial,$type,$subtype,$severity,$opaque")
                .url("$receive_time,$serial,$type,$subtype,$src,$dst,$url")
                .wildfire("$receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype")
                .escaping(EmailServerProfileFormatEscapingArgs.builder()
                    .escapeCharacter("\\")
                    .escapedCharacters("\"")
                    .build())
                .build())
            .build());

    }
}

resources:
  example:
    type: panos:Template
    properties:
      location:
        panorama: {}
      name: example-template
  # Email server profile forwarding security logs to a corporate SMTP relay
  # with authenticated SMTP and custom log format strings.
  exampleEmailServerProfile:
    type: panos:EmailServerProfile
    name: example
    properties:
      location:
        template:
          name: ${example.name}
      name: security-alerts-email
      servers:
        - name: corporate-smtp
          displayName: Corporate SMTP Relay
          from: panos-alerts@corp.example.com
          to: security-team@corp.example.com
          andAlsoTo: noc@corp.example.com
          gateway: smtp.corp.example.com
          protocol: SMTP
          port: 587
          authenticationType: Login
          username: panos-svc
          password: Str0ngP@ssw0rd!
      format:
        traffic: $receive_time,$serial,$type,$subtype,$src,$dst,$proto,$action
        threat: $receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$severity
        system: $receive_time,$serial,$type,$subtype,$severity,$opaque
        url: $receive_time,$serial,$type,$subtype,$src,$dst,$url
        wildfire: $receive_time,$serial,$type,$subtype,$src,$dst,$threat_name,$filetype
        escaping:
          escapeCharacter: \
          escapedCharacters: '"'

Create EmailServerProfile Resource

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

Constructor syntax

new EmailServerProfile(name: string, args: EmailServerProfileArgs, opts?: CustomResourceOptions);

@overload
def EmailServerProfile(resource_name: str,
                       args: EmailServerProfileArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def EmailServerProfile(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       location: Optional[EmailServerProfileLocationArgs] = None,
                       format: Optional[EmailServerProfileFormatArgs] = None,
                       name: Optional[str] = None,
                       servers: Optional[Sequence[EmailServerProfileServerArgs]] = None)

func NewEmailServerProfile(ctx *Context, name string, args EmailServerProfileArgs, opts ...ResourceOption) (*EmailServerProfile, error)

public EmailServerProfile(string name, EmailServerProfileArgs args, CustomResourceOptions? opts = null)

public EmailServerProfile(String name, EmailServerProfileArgs args)
public EmailServerProfile(String name, EmailServerProfileArgs args, CustomResourceOptions options)

type: panos:EmailServerProfile
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 EmailServerProfileArgs: 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 EmailServerProfileArgs: 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 EmailServerProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EmailServerProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EmailServerProfileArgs: 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 emailServerProfileResource = new Panos.EmailServerProfile("emailServerProfileResource", new()
{
    Location = new Panos.Inputs.EmailServerProfileLocationArgs
    {
        Panorama = null,
        Template = new Panos.Inputs.EmailServerProfileLocationTemplateArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        TemplateStack = new Panos.Inputs.EmailServerProfileLocationTemplateStackArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        TemplateStackVsys = new Panos.Inputs.EmailServerProfileLocationTemplateStackVsysArgs
        {
            NgfwDevice = "string",
            PanoramaDevice = "string",
            TemplateStack = "string",
            Vsys = "string",
        },
        TemplateVsys = new Panos.Inputs.EmailServerProfileLocationTemplateVsysArgs
        {
            NgfwDevice = "string",
            PanoramaDevice = "string",
            Template = "string",
            Vsys = "string",
        },
        Vsys = new Panos.Inputs.EmailServerProfileLocationVsysArgs
        {
            Name = "string",
            NgfwDevice = "string",
        },
    },
    Format = new Panos.Inputs.EmailServerProfileFormatArgs
    {
        Auth = "string",
        Config = "string",
        Correlation = "string",
        Data = "string",
        Decryption = "string",
        Escaping = new Panos.Inputs.EmailServerProfileFormatEscapingArgs
        {
            EscapeCharacter = "string",
            EscapedCharacters = "string",
        },
        Globalprotect = "string",
        Gtp = "string",
        HipMatch = "string",
        Iptag = "string",
        Sctp = "string",
        System = "string",
        Threat = "string",
        Traffic = "string",
        Tunnel = "string",
        Url = "string",
        Userid = "string",
        Wildfire = "string",
    },
    Name = "string",
    Servers = new[]
    {
        new Panos.Inputs.EmailServerProfileServerArgs
        {
            Name = "string",
            DisplayName = "string",
            CertificateProfile = "string",
            AndAlsoTo = "string",
            From = "string",
            Gateway = "string",
            AuthenticationType = "string",
            Password = "string",
            Port = 0,
            Protocol = "string",
            TlsVersion = "string",
            To = "string",
            Username = "string",
        },
    },
});

example, err := panos.NewEmailServerProfile(ctx, "emailServerProfileResource", &panos.EmailServerProfileArgs{
	Location: &panos.EmailServerProfileLocationArgs{
		Panorama: &panos.EmailServerProfileLocationPanoramaArgs{},
		Template: &panos.EmailServerProfileLocationTemplateArgs{
			Name:           pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		TemplateStack: &panos.EmailServerProfileLocationTemplateStackArgs{
			Name:           pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		TemplateStackVsys: &panos.EmailServerProfileLocationTemplateStackVsysArgs{
			NgfwDevice:     pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
			TemplateStack:  pulumi.String("string"),
			Vsys:           pulumi.String("string"),
		},
		TemplateVsys: &panos.EmailServerProfileLocationTemplateVsysArgs{
			NgfwDevice:     pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
			Template:       pulumi.String("string"),
			Vsys:           pulumi.String("string"),
		},
		Vsys: &panos.EmailServerProfileLocationVsysArgs{
			Name:       pulumi.String("string"),
			NgfwDevice: pulumi.String("string"),
		},
	},
	Format: &panos.EmailServerProfileFormatArgs{
		Auth:        pulumi.String("string"),
		Config:      pulumi.String("string"),
		Correlation: pulumi.String("string"),
		Data:        pulumi.String("string"),
		Decryption:  pulumi.String("string"),
		Escaping: &panos.EmailServerProfileFormatEscapingArgs{
			EscapeCharacter:   pulumi.String("string"),
			EscapedCharacters: pulumi.String("string"),
		},
		Globalprotect: pulumi.String("string"),
		Gtp:           pulumi.String("string"),
		HipMatch:      pulumi.String("string"),
		Iptag:         pulumi.String("string"),
		Sctp:          pulumi.String("string"),
		System:        pulumi.String("string"),
		Threat:        pulumi.String("string"),
		Traffic:       pulumi.String("string"),
		Tunnel:        pulumi.String("string"),
		Url:           pulumi.String("string"),
		Userid:        pulumi.String("string"),
		Wildfire:      pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Servers: panos.EmailServerProfileServerArray{
		&panos.EmailServerProfileServerArgs{
			Name:               pulumi.String("string"),
			DisplayName:        pulumi.String("string"),
			CertificateProfile: pulumi.String("string"),
			AndAlsoTo:          pulumi.String("string"),
			From:               pulumi.String("string"),
			Gateway:            pulumi.String("string"),
			AuthenticationType: pulumi.String("string"),
			Password:           pulumi.String("string"),
			Port:               pulumi.Float64(0),
			Protocol:           pulumi.String("string"),
			TlsVersion:         pulumi.String("string"),
			To:                 pulumi.String("string"),
			Username:           pulumi.String("string"),
		},
	},
})

var emailServerProfileResource = new EmailServerProfile("emailServerProfileResource", EmailServerProfileArgs.builder()
    .location(EmailServerProfileLocationArgs.builder()
        .panorama(EmailServerProfileLocationPanoramaArgs.builder()
            .build())
        .template(EmailServerProfileLocationTemplateArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .templateStack(EmailServerProfileLocationTemplateStackArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .templateStackVsys(EmailServerProfileLocationTemplateStackVsysArgs.builder()
            .ngfwDevice("string")
            .panoramaDevice("string")
            .templateStack("string")
            .vsys("string")
            .build())
        .templateVsys(EmailServerProfileLocationTemplateVsysArgs.builder()
            .ngfwDevice("string")
            .panoramaDevice("string")
            .template("string")
            .vsys("string")
            .build())
        .vsys(EmailServerProfileLocationVsysArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .build())
        .build())
    .format(EmailServerProfileFormatArgs.builder()
        .auth("string")
        .config("string")
        .correlation("string")
        .data("string")
        .decryption("string")
        .escaping(EmailServerProfileFormatEscapingArgs.builder()
            .escapeCharacter("string")
            .escapedCharacters("string")
            .build())
        .globalprotect("string")
        .gtp("string")
        .hipMatch("string")
        .iptag("string")
        .sctp("string")
        .system("string")
        .threat("string")
        .traffic("string")
        .tunnel("string")
        .url("string")
        .userid("string")
        .wildfire("string")
        .build())
    .name("string")
    .servers(EmailServerProfileServerArgs.builder()
        .name("string")
        .displayName("string")
        .certificateProfile("string")
        .andAlsoTo("string")
        .from("string")
        .gateway("string")
        .authenticationType("string")
        .password("string")
        .port(0.0)
        .protocol("string")
        .tlsVersion("string")
        .to("string")
        .username("string")
        .build())
    .build());

email_server_profile_resource = panos.EmailServerProfile("emailServerProfileResource",
    location={
        "panorama": {},
        "template": {
            "name": "string",
            "panorama_device": "string",
        },
        "template_stack": {
            "name": "string",
            "panorama_device": "string",
        },
        "template_stack_vsys": {
            "ngfw_device": "string",
            "panorama_device": "string",
            "template_stack": "string",
            "vsys": "string",
        },
        "template_vsys": {
            "ngfw_device": "string",
            "panorama_device": "string",
            "template": "string",
            "vsys": "string",
        },
        "vsys": {
            "name": "string",
            "ngfw_device": "string",
        },
    },
    format={
        "auth": "string",
        "config": "string",
        "correlation": "string",
        "data": "string",
        "decryption": "string",
        "escaping": {
            "escape_character": "string",
            "escaped_characters": "string",
        },
        "globalprotect": "string",
        "gtp": "string",
        "hip_match": "string",
        "iptag": "string",
        "sctp": "string",
        "system": "string",
        "threat": "string",
        "traffic": "string",
        "tunnel": "string",
        "url": "string",
        "userid": "string",
        "wildfire": "string",
    },
    name="string",
    servers=[{
        "name": "string",
        "display_name": "string",
        "certificate_profile": "string",
        "and_also_to": "string",
        "from_": "string",
        "gateway": "string",
        "authentication_type": "string",
        "password": "string",
        "port": float(0),
        "protocol": "string",
        "tls_version": "string",
        "to": "string",
        "username": "string",
    }])

const emailServerProfileResource = new panos.EmailServerProfile("emailServerProfileResource", {
    location: {
        panorama: {},
        template: {
            name: "string",
            panoramaDevice: "string",
        },
        templateStack: {
            name: "string",
            panoramaDevice: "string",
        },
        templateStackVsys: {
            ngfwDevice: "string",
            panoramaDevice: "string",
            templateStack: "string",
            vsys: "string",
        },
        templateVsys: {
            ngfwDevice: "string",
            panoramaDevice: "string",
            template: "string",
            vsys: "string",
        },
        vsys: {
            name: "string",
            ngfwDevice: "string",
        },
    },
    format: {
        auth: "string",
        config: "string",
        correlation: "string",
        data: "string",
        decryption: "string",
        escaping: {
            escapeCharacter: "string",
            escapedCharacters: "string",
        },
        globalprotect: "string",
        gtp: "string",
        hipMatch: "string",
        iptag: "string",
        sctp: "string",
        system: "string",
        threat: "string",
        traffic: "string",
        tunnel: "string",
        url: "string",
        userid: "string",
        wildfire: "string",
    },
    name: "string",
    servers: [{
        name: "string",
        displayName: "string",
        certificateProfile: "string",
        andAlsoTo: "string",
        from: "string",
        gateway: "string",
        authenticationType: "string",
        password: "string",
        port: 0,
        protocol: "string",
        tlsVersion: "string",
        to: "string",
        username: "string",
    }],
});

type: panos:EmailServerProfile
properties:
    format:
        auth: string
        config: string
        correlation: string
        data: string
        decryption: string
        escaping:
            escapeCharacter: string
            escapedCharacters: string
        globalprotect: string
        gtp: string
        hipMatch: string
        iptag: string
        sctp: string
        system: string
        threat: string
        traffic: string
        tunnel: string
        url: string
        userid: string
        wildfire: string
    location:
        panorama: {}
        template:
            name: string
            panoramaDevice: string
        templateStack:
            name: string
            panoramaDevice: string
        templateStackVsys:
            ngfwDevice: string
            panoramaDevice: string
            templateStack: string
            vsys: string
        templateVsys:
            ngfwDevice: string
            panoramaDevice: string
            template: string
            vsys: string
        vsys:
            name: string
            ngfwDevice: string
    name: string
    servers:
        - andAlsoTo: string
          authenticationType: string
          certificateProfile: string
          displayName: string
          from: string
          gateway: string
          name: string
          password: string
          port: 0
          protocol: string
          tlsVersion: string
          to: string
          username: string

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

Location EmailServerProfileLocation: The location of this object.
Format EmailServerProfileFormat
Name string
Servers List<EmailServerProfileServer>

Location EmailServerProfileLocationArgs: The location of this object.
Format EmailServerProfileFormatArgs
Name string
Servers []EmailServerProfileServerArgs

location EmailServerProfileLocation: The location of this object.
format EmailServerProfileFormat
name String
servers List<EmailServerProfileServer>

location EmailServerProfileLocation: The location of this object.
format EmailServerProfileFormat
name string
servers EmailServerProfileServer[]

location EmailServerProfileLocationArgs: The location of this object.
format EmailServerProfileFormatArgs
name str
servers Sequence[EmailServerProfileServerArgs]

location Property Map: The location of this object.
format Property Map
name String
servers List<Property Map>

Outputs

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

Get an existing EmailServerProfile 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?: EmailServerProfileState, opts?: CustomResourceOptions): EmailServerProfile

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        format: Optional[EmailServerProfileFormatArgs] = None,
        location: Optional[EmailServerProfileLocationArgs] = None,
        name: Optional[str] = None,
        servers: Optional[Sequence[EmailServerProfileServerArgs]] = None) -> EmailServerProfile

func GetEmailServerProfile(ctx *Context, name string, id IDInput, state *EmailServerProfileState, opts ...ResourceOption) (*EmailServerProfile, error)

public static EmailServerProfile Get(string name, Input<string> id, EmailServerProfileState? state, CustomResourceOptions? opts = null)

public static EmailServerProfile get(String name, Output<String> id, EmailServerProfileState state, CustomResourceOptions options)

resources:  _:    type: panos:EmailServerProfile    get:      id: ${id}

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.

The following state arguments are supported:

Format EmailServerProfileFormat
Location EmailServerProfileLocation: The location of this object.
Name string
Servers List<EmailServerProfileServer>

Format EmailServerProfileFormatArgs
Location EmailServerProfileLocationArgs: The location of this object.
Name string
Servers []EmailServerProfileServerArgs

format EmailServerProfileFormat
location EmailServerProfileLocation: The location of this object.
name String
servers List<EmailServerProfileServer>

format EmailServerProfileFormat
location EmailServerProfileLocation: The location of this object.
name string
servers EmailServerProfileServer[]

format EmailServerProfileFormatArgs
location EmailServerProfileLocationArgs: The location of this object.
name str
servers Sequence[EmailServerProfileServerArgs]

format Property Map
location Property Map: The location of this object.
name String
servers List<Property Map>

Supporting Types

EmailServerProfileFormat, EmailServerProfileFormatArgs

Auth string
Config string
Correlation string
Data string
Decryption string
Escaping EmailServerProfileFormatEscaping
Globalprotect string
Gtp string
HipMatch string
Iptag string
Sctp string
System string
Threat string
Traffic string
Tunnel string
Url string
Userid string
Wildfire string

Auth string
Config string
Correlation string
Data string
Decryption string
Escaping EmailServerProfileFormatEscaping
Globalprotect string
Gtp string
HipMatch string
Iptag string
Sctp string
System string
Threat string
Traffic string
Tunnel string
Url string
Userid string
Wildfire string

auth String
config String
correlation String
data String
decryption String
escaping EmailServerProfileFormatEscaping
globalprotect String
gtp String
hipMatch String
iptag String
sctp String
system String
threat String
traffic String
tunnel String
url String
userid String
wildfire String

auth string
config string
correlation string
data string
decryption string
escaping EmailServerProfileFormatEscaping
globalprotect string
gtp string
hipMatch string
iptag string
sctp string
system string
threat string
traffic string
tunnel string
url string
userid string
wildfire string

auth str
config str
correlation str
data str
decryption str
escaping EmailServerProfileFormatEscaping
globalprotect str
gtp str
hip_match str
iptag str
sctp str
system str
threat str
traffic str
tunnel str
url str
userid str
wildfire str

auth String
config String
correlation String
data String
decryption String
escaping Property Map
globalprotect String
gtp String
hipMatch String
iptag String
sctp String
system String
threat String
traffic String
tunnel String
url String
userid String
wildfire String

EmailServerProfileFormatEscaping, EmailServerProfileFormatEscapingArgs

EscapeCharacter string: Escape character
EscapedCharacters string: List of characters to be escaped

EscapeCharacter string: Escape character
EscapedCharacters string: List of characters to be escaped

escapeCharacter String: Escape character
escapedCharacters String: List of characters to be escaped

escapeCharacter string: Escape character
escapedCharacters string: List of characters to be escaped

escape_character str: Escape character
escaped_characters str: List of characters to be escaped

escapeCharacter String: Escape character
escapedCharacters String: List of characters to be escaped

EmailServerProfileLocation, EmailServerProfileLocationArgs

Panorama EmailServerProfileLocationPanorama: Located in a panorama.
Template EmailServerProfileLocationTemplate: A shared resource located within a specific template
TemplateStack EmailServerProfileLocationTemplateStack: Located in a specific template
TemplateStackVsys EmailServerProfileLocationTemplateStackVsys: Located in a specific template, device and vsys.
TemplateVsys EmailServerProfileLocationTemplateVsys: Located in a specific template, device and vsys.
Vsys EmailServerProfileLocationVsys: Located in a specific Virtual System

Panorama EmailServerProfileLocationPanorama: Located in a panorama.
Template EmailServerProfileLocationTemplate: A shared resource located within a specific template
TemplateStack EmailServerProfileLocationTemplateStack: Located in a specific template
TemplateStackVsys EmailServerProfileLocationTemplateStackVsys: Located in a specific template, device and vsys.
TemplateVsys EmailServerProfileLocationTemplateVsys: Located in a specific template, device and vsys.
Vsys EmailServerProfileLocationVsys: Located in a specific Virtual System

panorama EmailServerProfileLocationPanorama: Located in a panorama.
template EmailServerProfileLocationTemplate: A shared resource located within a specific template
templateStack EmailServerProfileLocationTemplateStack: Located in a specific template
templateStackVsys EmailServerProfileLocationTemplateStackVsys: Located in a specific template, device and vsys.
templateVsys EmailServerProfileLocationTemplateVsys: Located in a specific template, device and vsys.
vsys EmailServerProfileLocationVsys: Located in a specific Virtual System

panorama EmailServerProfileLocationPanorama: Located in a panorama.
template EmailServerProfileLocationTemplate: A shared resource located within a specific template
templateStack EmailServerProfileLocationTemplateStack: Located in a specific template
templateStackVsys EmailServerProfileLocationTemplateStackVsys: Located in a specific template, device and vsys.
templateVsys EmailServerProfileLocationTemplateVsys: Located in a specific template, device and vsys.
vsys EmailServerProfileLocationVsys: Located in a specific Virtual System

panorama EmailServerProfileLocationPanorama: Located in a panorama.
template EmailServerProfileLocationTemplate: A shared resource located within a specific template
template_stack EmailServerProfileLocationTemplateStack: Located in a specific template
template_stack_vsys EmailServerProfileLocationTemplateStackVsys: Located in a specific template, device and vsys.
template_vsys EmailServerProfileLocationTemplateVsys: Located in a specific template, device and vsys.
vsys EmailServerProfileLocationVsys: Located in a specific Virtual System

panorama Property Map: Located in a panorama.
template Property Map: A shared resource located within a specific template
templateStack Property Map: Located in a specific template
templateStackVsys Property Map: Located in a specific template, device and vsys.
templateVsys Property Map: Located in a specific template, device and vsys.
vsys Property Map: Located in a specific Virtual System

EmailServerProfileLocationTemplate, EmailServerProfileLocationTemplateArgs

Name string: Specific Panorama template
PanoramaDevice string: Specific Panorama device

Name string: Specific Panorama template
PanoramaDevice string: Specific Panorama device

name String: Specific Panorama template
panoramaDevice String: Specific Panorama device

name string: Specific Panorama template
panoramaDevice string: Specific Panorama device

name str: Specific Panorama template
panorama_device str: Specific Panorama device

name String: Specific Panorama template
panoramaDevice String: Specific Panorama device

EmailServerProfileLocationTemplateStack, EmailServerProfileLocationTemplateStackArgs

Name string: The template stack
PanoramaDevice string: Specific Panorama device

Name string: The template stack
PanoramaDevice string: Specific Panorama device

name String: The template stack
panoramaDevice String: Specific Panorama device

name string: The template stack
panoramaDevice string: Specific Panorama device

name str: The template stack
panorama_device str: Specific Panorama device

name String: The template stack
panoramaDevice String: Specific Panorama device

EmailServerProfileLocationTemplateStackVsys, EmailServerProfileLocationTemplateStackVsysArgs

NgfwDevice string: The NGFW device
PanoramaDevice string: Specific Panorama device
TemplateStack string: The template stack
Vsys string: The vsys.

NgfwDevice string: The NGFW device
PanoramaDevice string: Specific Panorama device
TemplateStack string: The template stack
Vsys string: The vsys.

ngfwDevice String: The NGFW device
panoramaDevice String: Specific Panorama device
templateStack String: The template stack
vsys String: The vsys.

ngfwDevice string: The NGFW device
panoramaDevice string: Specific Panorama device
templateStack string: The template stack
vsys string: The vsys.

ngfw_device str: The NGFW device
panorama_device str: Specific Panorama device
template_stack str: The template stack
vsys str: The vsys.

ngfwDevice String: The NGFW device
panoramaDevice String: Specific Panorama device
templateStack String: The template stack
vsys String: The vsys.

EmailServerProfileLocationTemplateVsys, EmailServerProfileLocationTemplateVsysArgs

NgfwDevice string: The NGFW device
PanoramaDevice string: Specific Panorama device
Template string: Specific Panorama template
Vsys string: The vsys.

NgfwDevice string: The NGFW device
PanoramaDevice string: Specific Panorama device
Template string: Specific Panorama template
Vsys string: The vsys.

ngfwDevice String: The NGFW device
panoramaDevice String: Specific Panorama device
template String: Specific Panorama template
vsys String: The vsys.

ngfwDevice string: The NGFW device
panoramaDevice string: Specific Panorama device
template string: Specific Panorama template
vsys string: The vsys.

ngfw_device str: The NGFW device
panorama_device str: Specific Panorama device
template str: Specific Panorama template
vsys str: The vsys.

ngfwDevice String: The NGFW device
panoramaDevice String: Specific Panorama device
template String: Specific Panorama template
vsys String: The vsys.

EmailServerProfileLocationVsys, EmailServerProfileLocationVsysArgs

Name string: The Virtual System name
NgfwDevice string: The NGFW device name

Name string: The Virtual System name
NgfwDevice string: The NGFW device name

name String: The Virtual System name
ngfwDevice String: The NGFW device name

name string: The Virtual System name
ngfwDevice string: The NGFW device name

name str: The Virtual System name
ngfw_device str: The NGFW device name

name String: The Virtual System name
ngfwDevice String: The NGFW device name

EmailServerProfileServer, EmailServerProfileServerArgs

Name string
AndAlsoTo string: email address (e.g. admin@mycompany.com)
AuthenticationType string
CertificateProfile string: Certificate Profile for validating server certificate
DisplayName string
From string: email address (e.g. admin@mycompany.com)
Gateway string: IP address or FQDN of SMTP gateway to use
Password string
Port double: Port number (Standard EMAIL ports SMTP:25, TLS:587)
Protocol string
TlsVersion string: TLS handshake protocol version
To string: email address (e.g. admin@mycompany.com)
Username string: username for authentication

Name string
AndAlsoTo string: email address (e.g. admin@mycompany.com)
AuthenticationType string
CertificateProfile string: Certificate Profile for validating server certificate
DisplayName string
From string: email address (e.g. admin@mycompany.com)
Gateway string: IP address or FQDN of SMTP gateway to use
Password string
Port float64: Port number (Standard EMAIL ports SMTP:25, TLS:587)
Protocol string
TlsVersion string: TLS handshake protocol version
To string: email address (e.g. admin@mycompany.com)
Username string: username for authentication

name String
andAlsoTo String: email address (e.g. admin@mycompany.com)
authenticationType String
certificateProfile String: Certificate Profile for validating server certificate
displayName String
from String: email address (e.g. admin@mycompany.com)
gateway String: IP address or FQDN of SMTP gateway to use
password String
port Double: Port number (Standard EMAIL ports SMTP:25, TLS:587)
protocol String
tlsVersion String: TLS handshake protocol version
to String: email address (e.g. admin@mycompany.com)
username String: username for authentication

name string
andAlsoTo string: email address (e.g. admin@mycompany.com)
authenticationType string
certificateProfile string: Certificate Profile for validating server certificate
displayName string
from string: email address (e.g. admin@mycompany.com)
gateway string: IP address or FQDN of SMTP gateway to use
password string
port number: Port number (Standard EMAIL ports SMTP:25, TLS:587)
protocol string
tlsVersion string: TLS handshake protocol version
to string: email address (e.g. admin@mycompany.com)
username string: username for authentication

name str
and_also_to str: email address (e.g. admin@mycompany.com)
authentication_type str
certificate_profile str: Certificate Profile for validating server certificate
display_name str
from_ str: email address (e.g. admin@mycompany.com)
gateway str: IP address or FQDN of SMTP gateway to use
password str
port float: Port number (Standard EMAIL ports SMTP:25, TLS:587)
protocol str
tls_version str: TLS handshake protocol version
to str: email address (e.g. admin@mycompany.com)
username str: username for authentication

name String
andAlsoTo String: email address (e.g. admin@mycompany.com)
authenticationType String
certificateProfile String: Certificate Profile for validating server certificate
displayName String
from String: email address (e.g. admin@mycompany.com)
gateway String: IP address or FQDN of SMTP gateway to use
password String
port Number: Port number (Standard EMAIL ports SMTP:25, TLS:587)
protocol String
tlsVersion String: TLS handshake protocol version
to String: email address (e.g. admin@mycompany.com)
username String: username for authentication

Import

An email server profile can be imported by providing the following base64 encoded object as the ID

{

location = {

template = {

  name            = "example-template"

  panorama_device = "localhost.localdomain"

}

}

name = “security-alerts-email”

}

$ pulumi import panos:index/emailServerProfile:EmailServerProfile example $(echo '{"location":{"template":{"name":"example-template","panorama_device":"localhost.localdomain"}},"name":"security-alerts-email"}' | base64)

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

Package Details

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

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks

Schema (JSON)

paloaltonetworks/terraform-provider-panos

panos.EmailServerProfile

On this page

On this page

Example Usage

Create EmailServerProfile Resource

Constructor syntax

Parameters

Constructor example

EmailServerProfile Resource Properties

Inputs

Outputs

Look up Existing EmailServerProfile Resource

Supporting Types

EmailServerProfileFormat, EmailServerProfileFormatArgs

EmailServerProfileFormatEscaping, EmailServerProfileFormatEscapingArgs

EmailServerProfileLocation, EmailServerProfileLocationArgs

EmailServerProfileLocationTemplate, EmailServerProfileLocationTemplateArgs

EmailServerProfileLocationTemplateStack, EmailServerProfileLocationTemplateStackArgs

EmailServerProfileLocationTemplateStackVsys, EmailServerProfileLocationTemplateStackVsysArgs

EmailServerProfileLocationTemplateVsys, EmailServerProfileLocationTemplateVsysArgs

EmailServerProfileLocationVsys, EmailServerProfileLocationVsysArgs

EmailServerProfileServer, EmailServerProfileServerArgs

Import

Package Details

On this page

On this page