Skip to main content

ContentPackInstaller

This Script is part of the Common Scripts Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

Install content packs from Marketplace.

Script Data#


NameDescription
Script Typepython3
Tagsconfiguration, Content Management
Cortex XSOAR Version6.0.0

Used In#


This script is used in the following playbooks and scripts.

  • Configuration Setup
  • Content Update Manager

Inputs#


Argument NameDescription
packs_dataInformation about the packs to install including pack ID and version.
pack_id_keyThe key in which the pack ID is stored.
pack_version_keyThe key in which the pack version is stored. Enter "latest" to update all packs to the latest version.
install_dependenciesWhether to install the pack dependencies.

Outputs#


PathDescriptionType
ContentPackInstaller.packnameThe name of the pack.Unknown
ContentPackInstaller.packversionThe version of the pack.Unknown
ContentPackInstaller.installationstatusThe installation status of the pack.Unknown

Command Examples#

Without escape chars#

!ContentPackInstaller packs_data=`[{"id":"GoogleCloudCompute","itemVersion":"latest"},{"id":"GoogleKubernetesEngine","itemVersion":"latest"},{"id":"GoogleSafeBrowsing","itemVersion":"latest"}]` pack_id_key=id pack_version_key=itemVersion

With escape chars#

!ContentPackInstaller packs_data="[{\"packid\": \"GoogleCloudCompute\",\"packversion\": \"latest\"}]" pack_id_key=packid pack_version_key=packversion

Troubleshooting#

Mulit-tenant environments#

Multi-tenant environments should be configured with the Cortex Rest API instance when using this automation. Make sure the Use tenant parameter (in the Cortex Rest API integration) is checked to ensure that API calls are made to the current tenant instead of the master tenant.

General Failures#

  • Make sure the Core REST API integration is configured correctly, and clicking the test button returns success.
  • Make sure you have a connection to Marketplace. You can check that by going to the Marketplace page in the Cortex XSOAR UI and refreshing.
  • Make sure the packs_data parameter value is in the correct format:
    • A list [] containing dictionaries {}. For each pack you want to install, add a dictionary with pack_id_key as the pack id key and pack_version_key as the pack version key as demonstrated in the command examples above.
    • The escape characters are in the right order and none are missing.