Set up and configure Broker VM - Learn more about how to set up and configure a Broker VM as a standalone broker or add the broker to a high availability (HA) cluster. - Administrator Guide - Cortex XDR - Cortex - Security Operations

Cortex XDR 3.x Documentation

Product
Cortex XDR
License
Prevent
Pro
Creation date
2024-03-06
Last date published
2025-12-24
Category
Administrator Guide
Abstract

Learn more about how to set up and configure a Broker VM as a standalone broker or add the broker to a high availability (HA) cluster.

You can set up a standalone Broker VM or add a Broker VM to a High Availability (HA) cluster to prevent a single point of failure. For more information, see Broker VM High Availability Cluster.

Setup

To set up the Broker virtual machine (VM), you need to deploy an image created by Palo Alto Networks on your network or supported cloud infrastructure and activate the available applications. You can set up several Broker VMs for the same tenant to support larger environments. Ensure each environment matches the necessary requirements.

Before you set up the Broker VM, verify you meet the following requirements:

The Broker VM utilizes a Certificate Authority (CA) certificate to establish trust with intermediary network devices, such as firewalls performing SSL/TLS decryption, positioned between the Broker VM and the tenant environment. Failure of the Broker VM to validate the certificate presented by an intermediate network component results in the termination of the SSL/TLS connection.

This CA certificate is optional to configure depending on your system configurations and helps provide more flexibility in securing communications between the Broker VM and the tenant according to your preferences and network topology. Specifically, it can help facilitate all communication between the Broker VM and tenant, such as the following:

  • Broker VM configuration: Secure transmission of configuration parameters.

  • Broker VM upgrades: Authenticated delivery and execution of upgrade packages.

  • Metric Uploads: Encrypted and authenticated transfer of operational metrics to the tenant.

Note

  • When configuring a Local Agent Settings applet with installer and content caching, you need to configure an SSL certificate for the Broker VM as explained in the task below. For more information on specific requirements for the Local Agent Settings applet, see Activate Local Agent Settings.

  • Keep in mind that several Broker VM applets, such as the Syslog Collector and Kafka Collector, have their own dedicated CA certificate bundle.

Perform the following procedures in the order listed below.

Note

When a Broker VM is disconnected for more than 30 days, it will have to go through a re-registration process.

  1. Select SettingsConfigurationsData BrokerBroker VMs.

  2. Click Add BrokerGenerate Token, and copy to your clipboard. The token is valid for 24 hours. A new token is generated each time you select Generate Token.

    You'll paste this token after configuring settings and the Broker VM is registered in Task 2. Register your Broker VM.

Depending on the Broker VM version, navigate to either of the following URLs:

  • From Broker VM version 19.x.x and later: https://<broker_vm_ip_address>.:4443

  • From Broker VM version 18.x.x and earlier: https://<broker_vm_ip_address>/

Note

When DHCP is not enabled in your network and there isn't an IP address for your Broker VM, configure the Broker VM with a static IP using the serial console menu.

Log in with the default password !nitialPassw0rd, and then define your own unique password. The password must contain a minimum of eight characters, contain letters and numbers, and at least one capital letter and one special character.

Perform the following procedures in the order listed below.

  1. Define the network interfaces settings.

    Review the pre-configured Name, IP address, and MAC Address, and select the Address Allocation: DHCP (default) or Static. If you choose Static, define the static IP address, Netmask, Default Gateway, and DNS Server settings, and then save your configurations.

    Important

    When configuring more than one network interface, ensure that only one Default Gateway is defined. The rest must be set to 0.0.0.0, which configures them as undefined. In addition, we recommend assigning each network interface to a different subnet, as oppose to configuring two interfaces on the same subnet which can potentially cause unexpected behavior.

    You can also specify which of the network interfaces is designated as the Admin and can be used to access the Broker VM web interface. Only one interface can be assigned for this purpose from all of the available network interfaces on the Broker VM, and the rest should be set to Disable.

  2. (Optional) Set the internal network settings (requires Broker VM 14.0.42 and later).

    Specify a network subnet to avoid the Broker VM dockers colliding with your internal network. By default, the Network Subnet is set to 172.17.0.1/16.

    Important

    Internal IP must be:

    • Formatted as prefix/mask, for example 192.0.2.1/24.

    • Must be within /8 to /24 range.

    • Cannot be configured to end with a zero.

    For Broker VM version 9.0 and earlier, Cortex XDR will only accept 172.17.0.0/16.

  3. (Optional) Configure a proxy server address and other related details to route Broker VM communication.

    1. Select the proxy Type as HTTP, SOCKS4, or SOCKS5.

      For any proxy selected, you must ensure the proxy supports HTTP/2, gRPC-specific headers, and HTTP/2 trailers, and the inspection policies support gRPC traffic. Any devices that you use with this configuration should also support these standards.

      Note

      You can configure another Broker VM as a proxy server for this Broker VM by selecting the HTTP type. When selecting HTTP to route Broker VM communication, you need to add the IP Address and Port number (set when activating the Agent Proxy) for another Broker VM registered in your tenant. This designates the other Broker VM as a proxy for this Broker VM.

    2. Specify the proxy Address (IP or FQDN), Port, and an optional User and Password. Select the pencil icon to specify the password. Avoid using special characters in the proxy username and password.

    3. Save your configurations.

  4. (Optional) Configure your NTP servers (requires Broker VM 8.0 and later).

    Specify the required server addresses using the FQDN or IP address of the server.

  5. (Optional) Allow SSH connections to the Broker VM (Requires Broker VM 8.0 and later).

    Important

    • We strongly recommend disabling SSH connectivity when it's not being used. Therefore, activate SSH connectivity when it's needed and disable it right afterwards.

    • When generating a new SSH key ensure to avoid embedding the domain-style username, by not using any backslashes (\) in the comment field, to ensure the SSH key passes validation.

    Enable or disable SSH connections to the Broker VM. SSH access is authenticated using a public key, provided by the user. Using a public key grants remote access to colleagues and Cortex XDR support who need the private key. You must have Instance Administrator role permissions to configure SSH access.

    To enable connection, generate an RSA Key Pair, and enter the public key in the SSH Public Key section. Once one SSH public key is added, you can Add Another. When you are finished, Save your configuration.

    When using PuTTYgen to create your public and private key pairs, you need to copy the public key generated in the Public key for pasting into OpenSSH authorized_keys file box, and paste it in the Broker VM SSH Public Key section as explained above. This public key is only available when the PuTTYgen console is open after the public key is generated. If you close the PuTTYgen console before pasting the public key, you will need to generate a new public key.

    When you SSH the Broker VM using PuTTY or a command prompt, you need to use the admin username. For example:

    ssh -i [/path/to/private.key] admin@[broker_vm_address]
  6. (Optional) Update the SSL Server certificates for the Broker VM.

    Upload your signed server certificate and key to establish a validated secure SSL connection between your endpoints and the Broker VM. Ensure the Private Key is uploaded in an unencrypted format. When you configure the server certificate and the key files in the Broker VM, Cortex XDR automatically updates them in the tenant UI. Cortex XDR validates that the certificate and key match, but does not validate the Certificate Authority (CA).

    Note

    The Palo Alto Networks Broker VM supports only strong cipher SHA256-based certificates. MD5/SHA1-based certificates are not supported.

  7. Update the Trusted CA Certificate for the Broker VM.

    Upload your Certificate Authority (CA) bundle file associated with the public TLS certificates belonging to the applicable firewalls, and click Save. These applicable firewalls include SSL/TLS decryption. For example, when configuring Palo Alto Networks NGFW to decrypt SSL using a self-signed certificate, you need to ensure the Broker VM can validate a self-signed CA by uploading the cert_ssl-decrypt.crt file on the Broker VM.

    Note

    If adding a CA certificate to the Broker VM is not possible, ensure that you’ve added the Broker Service FQDNs to the SSL Decryption Exclusion list on your firewalls. See Enable Access to Cortex XDR.

  8. (Optional) Configure the advanced settings of the Broker VM.

    You can decide whether to use a limited set of strong cipher suites for Broker VM communications by setting the toggle to Only use recommended cipher suites. You must enable this option to comply with Spain’s Esquema Nacional de Seguridad (ENS) National Security Framework. It's critical that you configure this option before you register the Broker VM with a tenant for compliance reasons.

  9. (Optional) Collect and Generate New Logs (Requires Broker VM 8.0 and later). Your Cortex XDR logs will download automatically after approximately 30 seconds.

Register and enter your unique Token, created in the Broker VMs page. This can take up to 30 seconds.

After a successful registration, Cortex XDR displays a notification.

You are directed to SettingsConfigurationsData BrokerBroker VMs. The Broker VMs page displays your Broker VM details and allows you to edit the defined configurations.