Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Panos Provider
  3. API Docs
  4. Provider
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-panos

panos.Provider

Explore with Pulumi AI

panos logo
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-panos

    The provider type for the panos package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             additional_headers: Optional[Mapping[str, str]] = None,
             api_key: Optional[str] = None,
             api_key_in_request: Optional[bool] = None,
             auth_file: Optional[str] = None,
             config_file: Optional[str] = None,
             hostname: Optional[str] = None,
             multi_config_batch_size: Optional[float] = None,
             panos_version: Optional[str] = None,
             password: Optional[str] = None,
             port: Optional[float] = None,
             protocol: Optional[str] = None,
             sdk_log_categories: Optional[str] = None,
             sdk_log_level: Optional[str] = None,
             skip_verify_certificate: Optional[bool] = None,
             target: Optional[str] = None,
             username: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:panos
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AdditionalHeaders Dictionary<string, string>
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    ApiKey string
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    ApiKeyInRequest bool
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    AuthFile string
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    ConfigFile string
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    Hostname string
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    MultiConfigBatchSize double
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    PanosVersion string
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    Password string
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    Port double
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    Protocol string
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    SdkLogCategories string
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    SdkLogLevel string
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    SkipVerifyCertificate bool
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    Target string
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    Username string
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.
    AdditionalHeaders map[string]string
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    ApiKey string
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    ApiKeyInRequest bool
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    AuthFile string
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    ConfigFile string
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    Hostname string
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    MultiConfigBatchSize float64
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    PanosVersion string
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    Password string
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    Port float64
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    Protocol string
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    SdkLogCategories string
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    SdkLogLevel string
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    SkipVerifyCertificate bool
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    Target string
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    Username string
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.
    additionalHeaders Map<String,String>
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    apiKey String
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    apiKeyInRequest Boolean
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    authFile String
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    configFile String
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    hostname String
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    multiConfigBatchSize Double
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    panosVersion String
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    password String
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    port Double
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    protocol String
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    sdkLogCategories String
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    sdkLogLevel String
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    skipVerifyCertificate Boolean
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    target String
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    username String
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.
    additionalHeaders {[key: string]: string}
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    apiKey string
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    apiKeyInRequest boolean
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    authFile string
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    configFile string
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    hostname string
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    multiConfigBatchSize number
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    panosVersion string
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    password string
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    port number
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    protocol string
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    sdkLogCategories string
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    sdkLogLevel string
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    skipVerifyCertificate boolean
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    target string
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    username string
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.
    additional_headers Mapping[str, str]
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    api_key str
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    api_key_in_request bool
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    auth_file str
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    config_file str
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    hostname str
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    multi_config_batch_size float
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    panos_version str
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    password str
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    port float
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    protocol str
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    sdk_log_categories str
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    sdk_log_level str
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    skip_verify_certificate bool
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    target str
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    username str
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.
    additionalHeaders Map<String>
    Additional HTTP headers to send with API calls Environment variable: PANOS_HEADERS. JSON config file variable: additional_headers.
    apiKey String
    The API key for PAN-OS. Either specify this or give both username and password. Environment variable: PANOS_API_KEY. JSON config file variable: api_key.
    apiKeyInRequest Boolean
    Send the API key in the request body instead of using the authentication header. Environment variable: PANOS_API_KEY_IN_REQUEST. JSON config file variable: api_key_in_request.
    authFile String
    Filesystem path to a JSON config file that specifies the provider's params. JSON config file variable: auth_file.
    configFile String
    (Local inspection mode) The PAN-OS config file to load read in using file() JSON config file variable: config_file.
    hostname String
    The hostname or IP address of the PAN-OS instance (NGFW or Panorama). Environment variable: PANOS_HOST. JSON config file variable: hostname.
    multiConfigBatchSize Number
    Number of operations to send as part of a single MultiConfig update Default: 500. Environment variable: PANOS_MULTI_CONFIG_BATCH_SIZE. JSON config file variable: multi_config_batch_size.
    panosVersion String
    (Local inspection mode) The version of PAN-OS that exported the config file. This is only used if the root 'config' block does not contain the 'detail-version' attribute. Example: 10.2.3. JSON config file variable: panos_version.
    password String
    The password. This is required if the api_key is not configured. Environment variable: PANOS_PASSWORD. JSON config file variable: password.
    port Number
    If the port is non-standard for the protocol, the port number to use. Environment variable: PANOS_PORT. JSON config file variable: port.
    protocol String
    The protocol (https or http). Default: https. Environment variable: PANOS_PROTOCOL. JSON config file variable: protocol.
    sdkLogCategories String
    Log categories to configure for the PAN-OS SDK library Environment variable: PANOS_LOG_CATEGORIES. JSON config file variable: sdk_log_categories.
    sdkLogLevel String
    SDK logging Level for categories Default: INFO. Environment variable: PANOS_LOG_LEVEL. JSON config file variable: sdk_log_level.
    skipVerifyCertificate Boolean
    (For https protocol) Skip verifying the HTTPS certificate. Environment variable: PANOS_SKIP_VERIFY_CERTIFICATE. JSON config file variable: skip_verify_certificate.
    target String
    Target setting (NGFW serial number). Environment variable: PANOS_TARGET. JSON config file variable: target.
    username String
    The username. This is required if api_key is not configured. Environment variable: PANOS_USERNAME. JSON config file variable: username.

    Outputs

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

    Package Details

    Repository
    panos paloaltonetworks/terraform-provider-panos
    License
    Notes
    This Pulumi package is based on the panos Terraform Provider.
    panos logo
    panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
    paloaltonetworks/terraform-provider-panos