Skip to content

feat: GlobalProtect forwarding profile sub-resource commands (SDK 0.15.0) #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdot65 merged 1 commit into from
Jun 11, 2026
Merged

feat: GlobalProtect forwarding profile sub-resource commands (SDK 0.15.0) #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 208 additions & 0 deletions docs/cli/mobile-agent/forwarding-profile-regional-and-custom-proxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
# Forwarding Profile Regional and Custom Proxy

Forwarding profile regional and custom proxies define how GlobalProtect forwarding profiles steer traffic to regional Prisma Access locations or custom explicit proxies in Strata Cloud Manager. The `scm` CLI provides commands to create, update, delete, show, backup, and load regional and custom proxies.

## Overview

The `forwarding-profile-regional-and-custom-proxy` commands allow you to:

- Create regional and custom proxy definitions for forwarding profiles
- Configure primary/secondary custom proxy servers, connectivity preferences, and fallback behavior
- Update existing proxy configurations
- Delete proxies that are no longer needed
- Bulk import proxies from YAML files
- Export proxies for backup or migration

!!! note
Forwarding profile regional and custom proxies live exclusively in the `Mobile Users` folder. Snippet and device locations are not supported.

## Field Reference

| Field | Values | Description |
| --- | --- | --- |
| `type` | `gp-and-pac` (default), `ztna-agent` | Proxy type |
| `proxy_1` / `proxy_2` | `fqdn`, `port` (1-65535), `location` | Custom proxy servers |
| `connectivity_preference` | `tunnel`, `proxy`, `adns`, `masque` (each with `enabled`) | Connectivity preference entries |
| `fallback_option` | `fail-open`, `fail-safe` | Behavior when the proxy is unreachable |
| `location_preference` | `best-available-pa-location`, `specific-pa-location` | Prisma Access location selection |
| `prisma_access_locations` | `name` (`americas`, `europe`, `apac`) + `locations` list | Specific Prisma Access locations |

## Set Forwarding Profile Regional and Custom Proxy

Create or update a forwarding profile regional and custom proxy.

### Syntax

```bash
scm set mobile-agent forwarding-profile-regional-and-custom-proxy [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the regional and custom proxy | Yes |
| `--type TEXT` | Proxy type (`gp-and-pac`, `ztna-agent`) | No |
| `--proxy-1-fqdn TEXT` | Primary proxy server FQDN | No |
| `--proxy-1-port INT` | Primary proxy server port (1-65535) | No |
| `--proxy-1-location TEXT` | Primary proxy server location | No |
| `--proxy-2-fqdn TEXT` | Secondary proxy server FQDN | No |
| `--proxy-2-port INT` | Secondary proxy server port (1-65535) | No |
| `--proxy-2-location TEXT` | Secondary proxy server location | No |
| `--fallback-option TEXT` | Fallback option (`fail-open`, `fail-safe`) | No |
| `--location-preference TEXT` | Location preference | No |
| `--description TEXT` | Description | No |

!!! tip
Nested `connectivity_preference` and `prisma_access_locations` entries are supported via the load command's YAML schema.

### Examples

```bash
$ scm set mobile-agent forwarding-profile-regional-and-custom-proxy \
--folder "Mobile Users" \
--name "emea-proxy" \
--type gp-and-pac \
--proxy-1-fqdn "proxy1.example.com" \
--proxy-1-port 8080 \
--fallback-option fail-open
Created forwarding profile regional and custom proxy: emea-proxy in folder Mobile Users
```

## Show Forwarding Profile Regional and Custom Proxy

Display forwarding profile regional and custom proxies.

### Syntax

```bash
scm show mobile-agent forwarding-profile-regional-and-custom-proxy [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the regional and custom proxy to show | No |

### Examples

```bash
# List all regional and custom proxies in the folder
$ scm show mobile-agent forwarding-profile-regional-and-custom-proxy --folder "Mobile Users"

# Show a specific regional and custom proxy by name
$ scm show mobile-agent forwarding-profile-regional-and-custom-proxy --folder "Mobile Users" --name "emea-proxy"
```

## Delete Forwarding Profile Regional and Custom Proxy

Remove a forwarding profile regional and custom proxy.

### Syntax

```bash
scm delete mobile-agent forwarding-profile-regional-and-custom-proxy [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the regional and custom proxy | Yes |
| `--force` | Skip confirmation prompt | No |

### Examples

```bash
$ scm delete mobile-agent forwarding-profile-regional-and-custom-proxy --folder "Mobile Users" --name "emea-proxy" --force
Deleted forwarding profile regional and custom proxy: emea-proxy from folder Mobile Users
```

## Backup Forwarding Profile Regional and Custom Proxy

Export all forwarding profile regional and custom proxies from a folder to a YAML file.

### Syntax

```bash
scm backup mobile-agent forwarding-profile-regional-and-custom-proxy [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder to backup from (defaults to `Mobile Users`) | No |
| `--file PATH` | Output file path (defaults to `forwarding-profile-regional-and-custom-proxy-{location}.yaml`) | No |

### Examples

```bash
$ scm backup mobile-agent forwarding-profile-regional-and-custom-proxy --folder "Mobile Users"
Successfully backed up 2 forwarding profile regional and custom proxies to forwarding-profile-regional-and-custom-proxy-mobile-users.yaml
```

## Load Forwarding Profile Regional and Custom Proxy

Bulk import forwarding profile regional and custom proxies from a YAML file. All nested fields are supported.

### Syntax

```bash
scm load mobile-agent forwarding-profile-regional-and-custom-proxy [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--file PATH` | YAML file to load from | Yes |
| `--dry-run` | Simulate execution without applying changes | No |
| `--folder TEXT` | Override folder location for all objects | No |

### YAML Schema

```yaml
forwarding_profile_regional_and_custom_proxies:
- name: emea-proxy
folder: "Mobile Users"
type: gp-and-pac
proxy_1:
fqdn: proxy1.example.com
port: 8080
proxy_2:
fqdn: proxy2.example.com
port: 8080
connectivity_preference:
- name: tunnel
enabled: true
- name: proxy
enabled: false
fallback_option: fail-open
- name: ztna-proxy
folder: "Mobile Users"
type: ztna-agent
location_preference: specific-pa-location
prisma_access_locations:
- name: europe
locations:
- "Frankfurt"
```

### Examples

```bash
# Preview without applying
$ scm load mobile-agent forwarding-profile-regional-and-custom-proxy --file regional_proxies.yml --dry-run

# Apply the configurations
$ scm load mobile-agent forwarding-profile-regional-and-custom-proxy --file regional_proxies.yml
Created forwarding profile regional and custom proxy: emea-proxy
Created forwarding profile regional and custom proxy: ztna-proxy

Summary: 2 created, 0 updated, 0 unchanged
```
171 changes: 171 additions & 0 deletions docs/cli/mobile-agent/forwarding-profile-source-application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
# Forwarding Profile Source Application

Forwarding profile source applications define the lists of applications used as source-application match criteria by GlobalProtect forwarding profiles in Strata Cloud Manager. The `scm` CLI provides commands to create, update, delete, show, backup, and load source applications.

## Overview

The `forwarding-profile-source-application` commands allow you to:

- Create source application lists for forwarding profile rules
- Update existing source application configurations
- Delete source applications that are no longer needed
- Bulk import source applications from YAML files
- Export source applications for backup or migration

!!! note
Forwarding profile source applications live exclusively in the `Mobile Users` folder. Snippet and device locations are not supported.

## Set Forwarding Profile Source Application

Create or update a forwarding profile source application.

### Syntax

```bash
scm set mobile-agent forwarding-profile-source-application [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the source application | Yes |
| `--application TEXT` | Application name (repeatable) | Yes |
| `--description TEXT` | Description | No |

### Examples

```bash
$ scm set mobile-agent forwarding-profile-source-application \
--folder "Mobile Users" \
--name "office-apps" \
--application slack \
--application zoom \
--description "Collaboration applications"
Created forwarding profile source application: office-apps in folder Mobile Users
```

## Show Forwarding Profile Source Application

Display forwarding profile source applications.

### Syntax

```bash
scm show mobile-agent forwarding-profile-source-application [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the source application to show | No |

### Examples

```bash
# List all source applications in the folder
$ scm show mobile-agent forwarding-profile-source-application --folder "Mobile Users"

# Show a specific source application by name
$ scm show mobile-agent forwarding-profile-source-application --folder "Mobile Users" --name "office-apps"
```

## Delete Forwarding Profile Source Application

Remove a forwarding profile source application.

### Syntax

```bash
scm delete mobile-agent forwarding-profile-source-application [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder location (must be `Mobile Users`) | Yes |
| `--name TEXT` | Name of the source application | Yes |
| `--force` | Skip confirmation prompt | No |

### Examples

```bash
$ scm delete mobile-agent forwarding-profile-source-application --folder "Mobile Users" --name "office-apps" --force
Deleted forwarding profile source application: office-apps from folder Mobile Users
```

## Backup Forwarding Profile Source Application

Export all forwarding profile source applications from a folder to a YAML file.

### Syntax

```bash
scm backup mobile-agent forwarding-profile-source-application [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--folder TEXT` | Folder to backup from (defaults to `Mobile Users`) | No |
| `--file PATH` | Output file path (defaults to `forwarding-profile-source-application-{location}.yaml`) | No |

### Examples

```bash
$ scm backup mobile-agent forwarding-profile-source-application --folder "Mobile Users"
Successfully backed up 2 forwarding profile source applications to forwarding-profile-source-application-mobile-users.yaml
```

## Load Forwarding Profile Source Application

Bulk import forwarding profile source applications from a YAML file.

### Syntax

```bash
scm load mobile-agent forwarding-profile-source-application [OPTIONS]
```

### Options

| Option | Description | Required |
| --- | --- | --- |
| `--file PATH` | YAML file to load from | Yes |
| `--dry-run` | Simulate execution without applying changes | No |
| `--folder TEXT` | Override folder location for all objects | No |

### YAML Schema

```yaml
forwarding_profile_source_applications:
- name: office-apps
folder: "Mobile Users"
description: Collaboration applications
applications:
- slack
- zoom
- name: dev-apps
folder: "Mobile Users"
applications:
- github
```

### Examples

```bash
# Preview without applying
$ scm load mobile-agent forwarding-profile-source-application --file source_applications.yml --dry-run

# Apply the configurations
$ scm load mobile-agent forwarding-profile-source-application --file source_applications.yml
Created forwarding profile source application: office-apps
Created forwarding profile source application: dev-apps

Summary: 2 created, 0 updated, 0 unchanged
```
Loading
Loading