1. Packages
  2. Packages
  3. Panos Provider
  4. API Docs
  5. getEmailServerProfile
Viewing docs for panos 2.0.12
published on Wednesday, Jun 17, 2026 by paloaltonetworks
Viewing docs for panos 2.0.12
published on Wednesday, Jun 17, 2026 by paloaltonetworks

    Using getEmailServerProfile

    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.

    function getEmailServerProfile(args: GetEmailServerProfileArgs, opts?: InvokeOptions): Promise<GetEmailServerProfileResult>
    function getEmailServerProfileOutput(args: GetEmailServerProfileOutputArgs, opts?: InvokeOptions): Output<GetEmailServerProfileResult>
    def get_email_server_profile(format: Optional[GetEmailServerProfileFormat] = None,
                                 location: Optional[GetEmailServerProfileLocation] = None,
                                 name: Optional[str] = None,
                                 servers: Optional[Sequence[GetEmailServerProfileServer]] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetEmailServerProfileResult
    def get_email_server_profile_output(format: pulumi.Input[Optional[GetEmailServerProfileFormatArgs]] = None,
                                 location: pulumi.Input[Optional[GetEmailServerProfileLocationArgs]] = None,
                                 name: pulumi.Input[Optional[str]] = None,
                                 servers: pulumi.Input[Optional[Sequence[pulumi.Input[GetEmailServerProfileServerArgs]]]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetEmailServerProfileResult]
    func LookupEmailServerProfile(ctx *Context, args *LookupEmailServerProfileArgs, opts ...InvokeOption) (*LookupEmailServerProfileResult, error)
    func LookupEmailServerProfileOutput(ctx *Context, args *LookupEmailServerProfileOutputArgs, opts ...InvokeOption) LookupEmailServerProfileResultOutput

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

    public static class GetEmailServerProfile 
    {
        public static Task<GetEmailServerProfileResult> InvokeAsync(GetEmailServerProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetEmailServerProfileResult> Invoke(GetEmailServerProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEmailServerProfileResult> getEmailServerProfile(GetEmailServerProfileArgs args, InvokeOptions options)
    public static Output<GetEmailServerProfileResult> getEmailServerProfile(GetEmailServerProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: panos:index/getEmailServerProfile:getEmailServerProfile
      arguments:
        # arguments dictionary
    data "panos_getemailserverprofile" "name" {
        # arguments
    }

    The following arguments are supported:

    location object
    The location of this object.
    name string
    format object
    servers list(object)
    List of email servers
    location Property Map
    The location of this object.
    name String
    format Property Map
    servers List<Property Map>
    List of email servers

    getEmailServerProfile Result

    The following output properties are available:

    Format GetEmailServerProfileFormat
    Id string
    The provider-assigned unique ID for this managed resource.
    Location GetEmailServerProfileLocation
    The location of this object.
    Name string
    Servers List<GetEmailServerProfileServer>
    List of email servers
    Format GetEmailServerProfileFormat
    Id string
    The provider-assigned unique ID for this managed resource.
    Location GetEmailServerProfileLocation
    The location of this object.
    Name string
    Servers []GetEmailServerProfileServer
    List of email servers
    format object
    id string
    The provider-assigned unique ID for this managed resource.
    location object
    The location of this object.
    name string
    servers list(object)
    List of email servers
    format GetEmailServerProfileFormat
    id String
    The provider-assigned unique ID for this managed resource.
    location GetEmailServerProfileLocation
    The location of this object.
    name String
    servers List<GetEmailServerProfileServer>
    List of email servers
    format GetEmailServerProfileFormat
    id string
    The provider-assigned unique ID for this managed resource.
    location GetEmailServerProfileLocation
    The location of this object.
    name string
    servers GetEmailServerProfileServer[]
    List of email servers
    format GetEmailServerProfileFormat
    id str
    The provider-assigned unique ID for this managed resource.
    location GetEmailServerProfileLocation
    The location of this object.
    name str
    servers Sequence[GetEmailServerProfileServer]
    List of email servers
    format Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    location Property Map
    The location of this object.
    name String
    servers List<Property Map>
    List of email servers

    Supporting Types

    GetEmailServerProfileFormat

    Auth string
    Custom format for auth log
    Config string
    Custom format for config log
    Correlation string
    Custom format for correlation log
    Data string
    Custom format for data log
    Decryption string
    Custom format for decryption log
    Escaping GetEmailServerProfileFormatEscaping
    Globalprotect string
    Custom format for globalprotect log
    Gtp string
    Custom format for gtp log
    HipMatch string
    Custom format for hip-match log
    Iptag string
    Custom format for iptag log
    Sctp string
    Custom format for sctp log
    System string
    Custom format for system log
    Threat string
    Custom format for threat log
    Traffic string
    Custom format for traffic log
    Tunnel string
    Custom format for tunnel log
    Url string
    Custom format for url log
    Userid string
    Custom format for userid log
    Wildfire string
    Custom format for wildfire log
    Auth string
    Custom format for auth log
    Config string
    Custom format for config log
    Correlation string
    Custom format for correlation log
    Data string
    Custom format for data log
    Decryption string
    Custom format for decryption log
    Escaping GetEmailServerProfileFormatEscaping
    Globalprotect string
    Custom format for globalprotect log
    Gtp string
    Custom format for gtp log
    HipMatch string
    Custom format for hip-match log
    Iptag string
    Custom format for iptag log
    Sctp string
    Custom format for sctp log
    System string
    Custom format for system log
    Threat string
    Custom format for threat log
    Traffic string
    Custom format for traffic log
    Tunnel string
    Custom format for tunnel log
    Url string
    Custom format for url log
    Userid string
    Custom format for userid log
    Wildfire string
    Custom format for wildfire log
    auth string
    Custom format for auth log
    config string
    Custom format for config log
    correlation string
    Custom format for correlation log
    data string
    Custom format for data log
    decryption string
    Custom format for decryption log
    escaping object
    globalprotect string
    Custom format for globalprotect log
    gtp string
    Custom format for gtp log
    hip_match string
    Custom format for hip-match log
    iptag string
    Custom format for iptag log
    sctp string
    Custom format for sctp log
    system string
    Custom format for system log
    threat string
    Custom format for threat log
    traffic string
    Custom format for traffic log
    tunnel string
    Custom format for tunnel log
    url string
    Custom format for url log
    userid string
    Custom format for userid log
    wildfire string
    Custom format for wildfire log
    auth String
    Custom format for auth log
    config String
    Custom format for config log
    correlation String
    Custom format for correlation log
    data String
    Custom format for data log
    decryption String
    Custom format for decryption log
    escaping GetEmailServerProfileFormatEscaping
    globalprotect String
    Custom format for globalprotect log
    gtp String
    Custom format for gtp log
    hipMatch String
    Custom format for hip-match log
    iptag String
    Custom format for iptag log
    sctp String
    Custom format for sctp log
    system String
    Custom format for system log
    threat String
    Custom format for threat log
    traffic String
    Custom format for traffic log
    tunnel String
    Custom format for tunnel log
    url String
    Custom format for url log
    userid String
    Custom format for userid log
    wildfire String
    Custom format for wildfire log
    auth string
    Custom format for auth log
    config string
    Custom format for config log
    correlation string
    Custom format for correlation log
    data string
    Custom format for data log
    decryption string
    Custom format for decryption log
    escaping GetEmailServerProfileFormatEscaping
    globalprotect string
    Custom format for globalprotect log
    gtp string
    Custom format for gtp log
    hipMatch string
    Custom format for hip-match log
    iptag string
    Custom format for iptag log
    sctp string
    Custom format for sctp log
    system string
    Custom format for system log
    threat string
    Custom format for threat log
    traffic string
    Custom format for traffic log
    tunnel string
    Custom format for tunnel log
    url string
    Custom format for url log
    userid string
    Custom format for userid log
    wildfire string
    Custom format for wildfire log
    auth str
    Custom format for auth log
    config str
    Custom format for config log
    correlation str
    Custom format for correlation log
    data str
    Custom format for data log
    decryption str
    Custom format for decryption log
    escaping GetEmailServerProfileFormatEscaping
    globalprotect str
    Custom format for globalprotect log
    gtp str
    Custom format for gtp log
    hip_match str
    Custom format for hip-match log
    iptag str
    Custom format for iptag log
    sctp str
    Custom format for sctp log
    system str
    Custom format for system log
    threat str
    Custom format for threat log
    traffic str
    Custom format for traffic log
    tunnel str
    Custom format for tunnel log
    url str
    Custom format for url log
    userid str
    Custom format for userid log
    wildfire str
    Custom format for wildfire log
    auth String
    Custom format for auth log
    config String
    Custom format for config log
    correlation String
    Custom format for correlation log
    data String
    Custom format for data log
    decryption String
    Custom format for decryption log
    escaping Property Map
    globalprotect String
    Custom format for globalprotect log
    gtp String
    Custom format for gtp log
    hipMatch String
    Custom format for hip-match log
    iptag String
    Custom format for iptag log
    sctp String
    Custom format for sctp log
    system String
    Custom format for system log
    threat String
    Custom format for threat log
    traffic String
    Custom format for traffic log
    tunnel String
    Custom format for tunnel log
    url String
    Custom format for url log
    userid String
    Custom format for userid log
    wildfire String
    Custom format for wildfire log

    GetEmailServerProfileFormatEscaping

    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 string
    Escape character
    escaped_characters 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

    GetEmailServerProfileLocation

    Panorama GetEmailServerProfileLocationPanorama
    Located in a panorama.
    Template GetEmailServerProfileLocationTemplate
    A shared resource located within a specific template
    TemplateStack GetEmailServerProfileLocationTemplateStack
    Located in a specific template
    TemplateStackVsys GetEmailServerProfileLocationTemplateStackVsys
    Located in a specific template, device and vsys.
    TemplateVsys GetEmailServerProfileLocationTemplateVsys
    Located in a specific template, device and vsys.
    Vsys GetEmailServerProfileLocationVsys
    Located in a specific Virtual System
    Panorama GetEmailServerProfileLocationPanorama
    Located in a panorama.
    Template GetEmailServerProfileLocationTemplate
    A shared resource located within a specific template
    TemplateStack GetEmailServerProfileLocationTemplateStack
    Located in a specific template
    TemplateStackVsys GetEmailServerProfileLocationTemplateStackVsys
    Located in a specific template, device and vsys.
    TemplateVsys GetEmailServerProfileLocationTemplateVsys
    Located in a specific template, device and vsys.
    Vsys GetEmailServerProfileLocationVsys
    Located in a specific Virtual System
    panorama object
    Located in a panorama.
    template object
    A shared resource located within a specific template
    template_stack object
    Located in a specific template
    template_stack_vsys object
    Located in a specific template, device and vsys.
    template_vsys object
    Located in a specific template, device and vsys.
    vsys object
    Located in a specific Virtual System
    panorama GetEmailServerProfileLocationPanorama
    Located in a panorama.
    template GetEmailServerProfileLocationTemplate
    A shared resource located within a specific template
    templateStack GetEmailServerProfileLocationTemplateStack
    Located in a specific template
    templateStackVsys GetEmailServerProfileLocationTemplateStackVsys
    Located in a specific template, device and vsys.
    templateVsys GetEmailServerProfileLocationTemplateVsys
    Located in a specific template, device and vsys.
    vsys GetEmailServerProfileLocationVsys
    Located in a specific Virtual System
    panorama GetEmailServerProfileLocationPanorama
    Located in a panorama.
    template GetEmailServerProfileLocationTemplate
    A shared resource located within a specific template
    templateStack GetEmailServerProfileLocationTemplateStack
    Located in a specific template
    templateStackVsys GetEmailServerProfileLocationTemplateStackVsys
    Located in a specific template, device and vsys.
    templateVsys GetEmailServerProfileLocationTemplateVsys
    Located in a specific template, device and vsys.
    vsys GetEmailServerProfileLocationVsys
    Located in a specific Virtual System
    panorama GetEmailServerProfileLocationPanorama
    Located in a panorama.
    template GetEmailServerProfileLocationTemplate
    A shared resource located within a specific template
    template_stack GetEmailServerProfileLocationTemplateStack
    Located in a specific template
    template_stack_vsys GetEmailServerProfileLocationTemplateStackVsys
    Located in a specific template, device and vsys.
    template_vsys GetEmailServerProfileLocationTemplateVsys
    Located in a specific template, device and vsys.
    vsys GetEmailServerProfileLocationVsys
    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

    GetEmailServerProfileLocationTemplate

    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
    panorama_device 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

    GetEmailServerProfileLocationTemplateStack

    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
    panorama_device 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

    GetEmailServerProfileLocationTemplateStackVsys

    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 string
    The NGFW device
    panorama_device string
    Specific Panorama device
    template_stack 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.

    GetEmailServerProfileLocationTemplateVsys

    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 string
    The NGFW device
    panorama_device 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.

    GetEmailServerProfileLocationVsys

    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
    ngfw_device 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

    GetEmailServerProfileServer

    AndAlsoTo string
    Additional CC email address
    AuthenticationType string
    Authentication method for SMTP
    CertificateProfile string
    Certificate profile for TLS verification
    DisplayName string
    From string
    From email address
    Gateway string
    IP address or FQDN of SMTP gateway
    Name string
    Password string
    Port double
    SMTP port number
    Protocol string
    TlsVersion string
    TLS handshake protocol version
    To string
    To email address
    Username string
    username for authentication
    AndAlsoTo string
    Additional CC email address
    AuthenticationType string
    Authentication method for SMTP
    CertificateProfile string
    Certificate profile for TLS verification
    DisplayName string
    From string
    From email address
    Gateway string
    IP address or FQDN of SMTP gateway
    Name string
    Password string
    Port float64
    SMTP port number
    Protocol string
    TlsVersion string
    TLS handshake protocol version
    To string
    To email address
    Username string
    username for authentication
    and_also_to string
    Additional CC email address
    authentication_type string
    Authentication method for SMTP
    certificate_profile string
    Certificate profile for TLS verification
    display_name string
    from string
    From email address
    gateway string
    IP address or FQDN of SMTP gateway
    name string
    password string
    port number
    SMTP port number
    protocol string
    tls_version string
    TLS handshake protocol version
    to string
    To email address
    username string
    username for authentication
    andAlsoTo String
    Additional CC email address
    authenticationType String
    Authentication method for SMTP
    certificateProfile String
    Certificate profile for TLS verification
    displayName String
    from String
    From email address
    gateway String
    IP address or FQDN of SMTP gateway
    name String
    password String
    port Double
    SMTP port number
    protocol String
    tlsVersion String
    TLS handshake protocol version
    to String
    To email address
    username String
    username for authentication
    andAlsoTo string
    Additional CC email address
    authenticationType string
    Authentication method for SMTP
    certificateProfile string
    Certificate profile for TLS verification
    displayName string
    from string
    From email address
    gateway string
    IP address or FQDN of SMTP gateway
    name string
    password string
    port number
    SMTP port number
    protocol string
    tlsVersion string
    TLS handshake protocol version
    to string
    To email address
    username string
    username for authentication
    and_also_to str
    Additional CC email address
    authentication_type str
    Authentication method for SMTP
    certificate_profile str
    Certificate profile for TLS verification
    display_name str
    from_ str
    From email address
    gateway str
    IP address or FQDN of SMTP gateway
    name str
    password str
    port float
    SMTP port number
    protocol str
    tls_version str
    TLS handshake protocol version
    to str
    To email address
    username str
    username for authentication
    andAlsoTo String
    Additional CC email address
    authenticationType String
    Authentication method for SMTP
    certificateProfile String
    Certificate profile for TLS verification
    displayName String
    from String
    From email address
    gateway String
    IP address or FQDN of SMTP gateway
    name String
    password String
    port Number
    SMTP port number
    protocol String
    tlsVersion String
    TLS handshake protocol version
    to String
    To email address
    username String
    username for authentication

    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.12
    published on Wednesday, Jun 17, 2026 by paloaltonetworks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial