Skip to main content

IPsec Crypto Profile

IPsec crypto profiles define encryption and authentication parameters for IPsec Phase 2 (ESP) negotiations. The scm CLI provides commands to create, update, delete, and load IPsec crypto profiles.

Overview​

The ipsec-crypto-profile commands allow you to:

  • Create IPsec crypto profiles with ESP encryption and authentication settings
  • Update existing IPsec crypto profile configurations
  • Delete IPsec crypto profiles that are no longer needed
  • Bulk import IPsec crypto profiles from YAML files
  • Export IPsec crypto profiles for backup or migration

Set IPsec Crypto Profile​

Create or update an IPsec crypto profile.

Syntax​

scm set network ipsec-crypto-profile NAME [OPTIONS]

Arguments​

ArgumentDescriptionRequired
NAMEName of the IPsec crypto profileYes

Options​

OptionDescriptionRequired
--folder TEXTFolder locationYes*
--snippet TEXTSnippet locationYes*
--device TEXTDevice locationYes*
--esp-encryption TEXTESP encryption algorithms (aes-256-cbc, aes-128-cbc, etc.; default: aes-256-cbc)No
--esp-authentication TEXTESP authentication algorithms (sha256, sha384, sha512, sha1, md5; default: sha256)No
--dh-group TEXTDH group for PFS (group14, group19, group20, no-pfs; default: group14)No
--lifetime-seconds INTLifetime in secondsNo
--lifetime-hours INTLifetime in hoursNo

* Exactly one of --folder, --snippet, or --device is required.

Examples​

Create an IPsec Crypto Profile​

$ scm set network ipsec-crypto-profile my-ipsec-profile \
--folder Texas \
--esp-encryption aes-256-cbc \
--esp-authentication sha256 \
--dh-group group14
---> 100%
Created IPsec crypto profile: my-ipsec-profile in folder Texas

Create a Profile with Custom Lifetime​

$ scm set network ipsec-crypto-profile short-lived-profile \
--folder Texas \
--esp-encryption aes-256-cbc \
--esp-authentication sha384 \
--dh-group group19 \
--lifetime-hours 1
---> 100%
Created IPsec crypto profile: short-lived-profile in folder Texas

Delete IPsec Crypto Profile​

Delete an IPsec crypto profile from SCM.

Syntax​

scm delete network ipsec-crypto-profile NAME [OPTIONS]

Arguments​

ArgumentDescriptionRequired
NAMEName of the IPsec crypto profile to deleteYes

Options​

OptionDescriptionRequired
--folder TEXTFolder locationYes*
--snippet TEXTSnippet locationYes*
--device TEXTDevice locationYes*
--forceSkip confirmation promptNo

* Exactly one of --folder, --snippet, or --device is required.

Example​

$ scm delete network ipsec-crypto-profile my-ipsec-profile --folder Texas --force
---> 100%
Deleted IPsec crypto profile: my-ipsec-profile from folder Texas

Load IPsec Crypto Profile​

Load multiple IPsec crypto profiles from a YAML file.

Syntax​

scm load network ipsec-crypto-profile [OPTIONS]

Options​

OptionDescriptionRequired
--file TEXTPath to YAML fileYes
--folder TEXTOverride folder location for all objectsNo
--snippet TEXTOverride snippet location for all objectsNo
--device TEXTOverride device location for all objectsNo
--dry-runPreview changes without applyingNo

YAML File Format​

---
ipsec_crypto_profiles:
- name: standard-ipsec
folder: Texas
esp:
encryption:
- aes-256-cbc
authentication:
- sha256
dh_group: group14
lifetime_hours: 8

- name: high-security-ipsec
folder: Texas
esp:
encryption:
- aes-256-cbc
authentication:
- sha384
dh_group: group19
lifetime_hours: 4

Examples​

Load with Original Locations​

$ scm load network ipsec-crypto-profile --file ipsec-profiles.yml
---> 100%
✓ Loaded IPsec crypto profile: standard-ipsec
✓ Loaded IPsec crypto profile: high-security-ipsec

Successfully loaded 2 out of 2 IPsec crypto profiles from 'ipsec-profiles.yml'

Load with Folder Override​

$ scm load network ipsec-crypto-profile --file ipsec-profiles.yml --folder Austin
---> 100%
✓ Loaded IPsec crypto profile: standard-ipsec
✓ Loaded IPsec crypto profile: high-security-ipsec

Successfully loaded 2 out of 2 IPsec crypto profiles from 'ipsec-profiles.yml'
note

When using container override options (--folder, --snippet, --device), all IPsec crypto profiles will be loaded into the specified container, ignoring the container specified in the YAML file.

Show IPsec Crypto Profile​

Display IPsec crypto profile objects.

Syntax​

scm show network ipsec-crypto-profile [NAME] [OPTIONS]

Arguments​

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

Options​

OptionDescriptionRequired
--folder TEXTFolder locationYes*
--snippet TEXTSnippet locationYes*
--device TEXTDevice locationYes*
--max-results INTEGERMaximum number of results to displayNo
--output [table|json|yaml]Output format (default: table)No

* Exactly one of --folder, --snippet, or --device is required.

note

When no NAME argument is provided, all items are listed by default.

Examples​

Show Specific IPsec Crypto Profile​

$ scm show network ipsec-crypto-profile my-ipsec-profile --folder Texas
---> 100%
IPsec Crypto Profile: my-ipsec-profile
Location: Folder 'Texas'
ESP Encryption: aes-256-cbc
ESP Authentication: sha256
DH Group: group14

List All IPsec Crypto Profiles (Default Behavior)​

$ scm show network ipsec-crypto-profile --folder Texas
---> 100%
IPsec crypto profiles in folder 'Texas':
------------------------------------------------------------
Name: standard-ipsec
ESP Encryption: aes-256-cbc
DH Group: group14
------------------------------------------------------------
Name: high-security-ipsec
ESP Encryption: aes-256-cbc
DH Group: group19
------------------------------------------------------------

Backup IPsec Crypto Profiles​

Backup all IPsec crypto profile objects from a specified location to a YAML file.

Syntax​

scm backup network ipsec-crypto-profile [OPTIONS]

Options​

OptionDescriptionRequired
--folder TEXTFolder locationNo*
--snippet TEXTSnippet locationNo*
--device TEXTDevice locationNo*
--file TEXTCustom output filenameNo

* One of --folder, --snippet, or --device is required.

Examples​

Backup from Folder​

$ scm backup network ipsec-crypto-profile --folder Texas
---> 100%
Successfully backed up 5 IPsec crypto profiles to ipsec_crypto_profile_folder_texas_20240115_120530.yaml

Backup with Custom Filename​

$ scm backup network ipsec-crypto-profile --folder Texas --file texas-ipsec-profiles.yaml
---> 100%
Successfully backed up 5 IPsec crypto profiles to texas-ipsec-profiles.yaml

Best Practices​

  1. Enable PFS: Use a DH group (group14 or higher) for Perfect Forward Secrecy rather than no-pfs.
  2. Use Strong Encryption: Prefer aes-256-cbc with sha256 or higher authentication for production tunnels.
  3. Match IKE and IPsec Profiles: Ensure IPsec profile security level is consistent with the paired IKE crypto profile.
  4. Set Appropriate Lifetimes: Shorter lifetimes increase security but may impact performance during rekeying.
  5. Backup Before Changes: Always backup existing profiles before making bulk modifications.