Skip to main content

Forwarding Profile

Forwarding profiles control how GlobalProtect mobile agent traffic is forwarded (PAC file, GlobalProtect proxy, or ZTNA agent) in Strata Cloud Manager. The scm CLI provides commands to create, update, delete, show, backup, and load forwarding profiles.

Overview​

The forwarding-profile commands allow you to:

  • Create forwarding profiles of type PAC file, GlobalProtect proxy, or ZTNA agent
  • Update existing forwarding profile configurations
  • Delete forwarding profiles by name or UUID
  • Show a profile by name or UUID, or list all profiles
  • Bulk import forwarding profiles (including forwarding rules and block rules) from YAML files
  • Export forwarding profiles for backup or migration
note

Forwarding profiles only support the Mobile Users folder. The API addresses individual profiles by UUID; the CLI resolves the NAME argument to the UUID for you, or you can pass --id directly.

Profile Types​

Type--profile-type valueYAML type keyDescription
PAC filepac-filepac_fileForwarding driven by a PAC file
GlobalProtect proxyglobal-protect-proxyglobal_protect_proxyForwarding via GlobalProtect proxy
ZTNA agentztna-agentztna_agentZTNA agent forwarding with traffic-type rules

Set Forwarding Profile​

Create or update a forwarding profile.

Syntax​

scm set mobile-agent forwarding-profile NAME [OPTIONS]

Arguments​

ArgumentDescriptionRequired
NAMEName of the forwarding profileYes

Options​

OptionDescriptionRequired
--folder TEXTFolder location (must be Mobile Users)Yes
--description TEXTDescriptionNo
--definition-method TEXTHow the profile is defined: rules or pac-fileNo
--profile-type TEXTProfile type: pac-file, global-protect-proxy, or ztna-agentNo
--pac-upload / --no-pac-uploadWhether the user uploads a PAC fileNo

Complex forwarding rules and block rules are not expressible as flags — use Load Forwarding Profile with a YAML file for those.

Examples​

Create ZTNA Agent Profile​

$ scm set mobile-agent forwarding-profile "ztna-profile" \
--folder "Mobile Users" \
--profile-type ztna-agent
Created forwarding profile: ztna-profile

Create GlobalProtect Proxy Profile with PAC Upload​

$ scm set mobile-agent forwarding-profile "proxy-profile" \
--folder "Mobile Users" \
--profile-type global-protect-proxy \
--pac-upload
Created forwarding profile: proxy-profile

Show Forwarding Profile​

Display forwarding profiles.

Syntax​

scm show mobile-agent forwarding-profile [NAME] [OPTIONS]

Arguments​

ArgumentDescriptionRequired
NAMEName of the profile to show; omit to list allNo

Options​

OptionDescriptionRequired
--folder TEXTFolder locationNo (defaults to Mobile Users)
--id TEXTUUID of the profile to showNo
--output, -o [table|json|yaml]Output format (default: table)No
--max-results INTEGERMaximum number of results to displayNo

Examples​

# List all forwarding profiles
$ scm show mobile-agent forwarding-profile --folder "Mobile Users"

# Show by name
$ scm show mobile-agent forwarding-profile "ztna-profile" --folder "Mobile Users"

# Show by UUID
$ scm show mobile-agent forwarding-profile --id "123e4567-e89b-12d3-a456-426655440000"

Delete Forwarding Profile​

Delete a forwarding profile by name or UUID.

Syntax​

scm delete mobile-agent forwarding-profile [NAME] [OPTIONS]

Arguments​

ArgumentDescriptionRequired
NAMEName of the profile to delete (omit when using --id)No

Options​

OptionDescriptionRequired
--folder TEXTFolder locationNo (defaults to Mobile Users)
--id TEXTUUID of the profile to deleteNo
--forceSkip confirmation promptNo

Examples​

$ scm delete mobile-agent forwarding-profile "ztna-profile" --folder "Mobile Users" --force
Deleted forwarding profile: ztna-profile

Load Forwarding Profile​

Bulk import forwarding profiles from a YAML file. This is the path for full configurations including forwarding rules and block rules.

Syntax​

scm load mobile-agent forwarding-profile --file FILE [OPTIONS]

Options​

OptionDescriptionRequired
--file PATHYAML file to load fromYes
--dry-runPreview without applyingNo
--folder TEXTOverride folder for all objectsNo

YAML Format​

forwarding_profiles:
- name: ztna-profile
folder: "Mobile Users"
definition_method: rules
type:
ztna_agent:
pac_upload: false
forwarding_rules:
- name: rule1
traffic_type: dns # dns | dns-and-network-traffic | network-traffic
enabled: true
user_locations: Any
source_applications: Any
destinations: Any
connectivity: direct
block_rule:
block_all_other_unmatched_outbound_connections: true
allow_icmp_for_troubleshooting: true
- name: pac-profile
folder: "Mobile Users"
definition_method: pac-file
type:
pac_file:
pac_upload: true
forwarding_rules:
- name: rule1
enabled: true
connectivity: direct
block_rule:
enable: true
allow_tcp:
enable_locations: true
locations:
- "US"

Backup Forwarding Profile​

Export all forwarding profiles in a folder to a YAML file (re-loadable via scm load).

Syntax​

scm backup mobile-agent forwarding-profile [OPTIONS]

Options​

OptionDescriptionRequired
--folder TEXTFolder to backup fromNo (defaults to Mobile Users)
--file PATHOutput file (defaults to forwarding-profile-{folder}.yaml)No

Examples​

$ scm backup mobile-agent forwarding-profile --folder "Mobile Users"
Successfully backed up 2 forwarding profiles to forwarding-profile-mobile-users.yaml