SIG Credentials Feature Template

Version:

Configure Cisco Security Internet Gateway (SIG) credentials feature templates to automate tunnel provisioning.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
sig_credentials_templates	List	`[sig_credentials_templates]`	No

sig_credentials_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	Choice	`Cisco-Umbrella-Global-Credentials`, `Cisco-Zscaler-Global-Credentials`	Yes
umbrella_api_key	String	Regex: `^[0-9a-z]{1,32}$`	No
umbrella_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_api_secret	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
umbrella_api_secret_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_organization_id	Integer	min: `1000000`, max: `9999999`	No
umbrella_organization_id_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_organization	String		No
zscaler_organization_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_base_uri	String		No
zscaler_partner_base_uri_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_username	String		No
zscaler_username_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
zscaler_password_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_api_key	String	min: `1`, max: `12`	No
zscaler_partner_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No

Examples

Example-1: This example shows how to configure a SIG credentials feature template for Cisco Umbrella. The template includes the global credentials required for Umbrella integration, such as the API key, API secret, and organization ID. These parameters enable automated provisioning and secure connectivity to Cisco Umbrella services within the SD-WAN environment.

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: Cisco-Umbrella-Global-Credentials
        umbrella_api_key_variable: umbrella_api_key_var
        umbrella_api_secret_variable: umbrella_api_secret_var
        umbrella_organization_id: 1000001

Example-2: This example demonstrates how to configure a SIG credentials feature template for Cisco Zscaler. The template includes the required global credentials for Zscaler integration, such as the partner API key, username, password, base URI, and organization name. These parameters enable secure authentication and automated connectivity to Cisco Zscaler services within the SD-WAN environment.

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: Cisco-Zscaler-Global-Credentials
        zscaler_organization: ciscozscalerorganization
        zscaler_partner_base_uri: https://ciscozscalerpartnerbaseuri
        zscaler_username: ciscozscalerusername
        zscaler_password_variable: zscaler_password_var
        zscaler_partner_api_key_variable: zscaler_partner_api_key_var

Configure Cisco Security Internet Gateway (SIG) credentials feature templates to automate tunnel provisioning.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
sig_credentials_templates	List	`[sig_credentials_templates]`	No

sig_credentials_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	Choice	`Cisco-Umbrella-Global-Credentials`, `Cisco-Zscaler-Global-Credentials`	Yes
umbrella_api_key	String	Regex: `^[0-9a-z]{1,32}$`	No
umbrella_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_api_secret	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
umbrella_api_secret_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_organization_id	Integer	min: `1000000`, max: `9999999`	No
umbrella_organization_id_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_organization	String		No
zscaler_organization_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_base_uri	String		No
zscaler_partner_base_uri_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_username	String		No
zscaler_username_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
zscaler_password_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_api_key	String	min: `1`, max: `12`	No
zscaler_partner_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No

Examples

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: Cisco-Umbrella-Global-Credentials
        umbrella_api_key: 7f33d6ee0d56402c83c503a669a80d22
        umbrella_api_secret: $CRYPT_CLUSTER$5dYqYjx7vO3/77uFutA+Sg==$m0ROjLW4OiuqFNkDQUFwoSwjbFB3aYhTj2KL+/g2HKygHy/EgUInhDtHXCUuKrxq
        umbrella_organization_id: 1234567

Configure Cisco Security Internet Gateway (SIG) credentials feature templates to automate tunnel provisioning.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
sig_credentials_templates	List	`[sig_credentials_templates]`	No

sig_credentials_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	Choice	`umbrella`, `zscaler`	Yes
umbrella_api_key	String	Regex: `^[0-9a-z]{1,32}$`	No
umbrella_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_api_secret	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
umbrella_api_secret_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_organization_id	Integer	min: `1000000`, max: `9999999`	No
umbrella_organization_id_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_organization	String		No
zscaler_organization_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_base_uri	String		No
zscaler_partner_base_uri_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_username	String		No
zscaler_username_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
zscaler_password_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_api_key	String	Regex: `^[0-9a-z]{1,12}$`	No
zscaler_partner_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No

Examples

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: FT-CEDGE-SIG-CREDS-UMBRELLA-01
        description: "Global Umbrella SIG Credentials"
        umbrella_api_key: 7f33d6ee0d56402c83c503a669a80d22
        umbrella_api_secret: $CRYPT_CLUSTER$5dYqYjx7vO3/77uFutA+Sg==$m0ROjLW4OiuqFNkDQUFwoSwjbFB3aYhTj2KL+/g2HKygHy/EgUInhDtHXCUuKrxq
        umbrella_organization_id: 1234567

Configure Cisco Security Internet Gateway (SIG) credentials feature templates to automate tunnel provisioning.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
sig_credentials_templates	List	`[sig_credentials_templates]`	No

sig_credentials_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	Choice	`umbrella`, `zscaler`	Yes
umbrella_api_key	String	Regex: `^[0-9a-z]{1,32}$`	No
umbrella_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_api_secret	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
umbrella_api_secret_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_organization_id	Integer	min: `1000000`, max: `9999999`	No
umbrella_organization_id_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_organization	String		No
zscaler_organization_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_base_uri	String		No
zscaler_partner_base_uri_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_username	String		No
zscaler_username_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
zscaler_password_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_api_key	String	Regex: `^[0-9a-z]{1,12}$`	No
zscaler_partner_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No

Examples

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: FT-CEDGE-SIG-CREDS-UMBRELLA-01
        description: "Global Umbrella SIG Credentials"
        umbrella_api_key: 7f33d6ee0d56402c83c503a669a80d22
        umbrella_api_secret: $CRYPT_CLUSTER$5dYqYjx7vO3/77uFutA+Sg==$m0ROjLW4OiuqFNkDQUFwoSwjbFB3aYhTj2KL+/g2HKygHy/EgUInhDtHXCUuKrxq
        umbrella_organization_id: 1234567

Configure Cisco Security Internet Gateway (SIG) credentials feature templates to automate tunnel provisioning.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
sig_credentials_templates	List	`[sig_credentials_templates]`	No

sig_credentials_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	Choice	`umbrella`, `zscaler`	Yes
umbrella_api_key	String	Regex: `^[0-9a-z]{1,32}$`	No
umbrella_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_api_secret	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
umbrella_api_secret_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
umbrella_organization_id	Integer	min: `1000000`, max: `9999999`	No
umbrella_organization_id_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_organization	String		No
zscaler_organization_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_base_uri	String		No
zscaler_partner_base_uri_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_username	String		No
zscaler_username_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
zscaler_password_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No
zscaler_partner_api_key	String	Regex: `^[0-9a-z]{1,12}$`	No
zscaler_partner_api_key_variable	String	Regex: ^[^"~`$&+,]{1,255}$	No

Examples

sdwan:
  edge_feature_templates:
    sig_credentials_templates:
      - name: FT-CEDGE-SIG-CREDS-UMBRELLA-01
        description: "Global Umbrella SIG Credentials"
        umbrella_api_key: 7f33d6ee0d56402c83c503a669a80d22
        umbrella_api_secret: $CRYPT_CLUSTER$5dYqYjx7vO3/77uFutA+Sg==$m0ROjLW4OiuqFNkDQUFwoSwjbFB3aYhTj2KL+/g2HKygHy/EgUInhDtHXCUuKrxq
        umbrella_organization_id: 1234567