Skip to main content

Versa Director

This Integration is part of the VersaDirector Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.5.0 and later.

Versa Director is a virtualization and service creation platform that simplifies the design, automation, and delivery of SASE services. Versa Director provides the essential management, monitoring and orchestration capabilities needed to deliver all of the networking and security capabilities within Versa SASE. This integration was integrated and tested with version 1.0.0 of VersaDirector

Configure Versa Director on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Versa Director.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Your server URLTrue
    Organization NameUsed by any command that requires organization argument. should be passed as parameter in configuration or as command argument.False
    UsernameUsername parameter is used for Basic Authentication.False
    PasswordPassword parameter is used for Basic Authentication.False
    Use Basic AuthenticationCheck this checkbox to use the basic authentication method. Auth Token authentication will be used by default. To use basic authentication method, please enter Username and Password parameters.False
    Client IDThe Client ID parameter is used for Auth authentication. Used together with Client Secret parameter.False
    Client SecretThe Client Secret parameter is used for Auth authentication. Used together with Client ID parameter.False
    Auth TokenThe Auth Token parameter is used for Auth authentication.
    An Auth Token passed as a parameter take priority over an Auth Token saved in the integration context by default.
    If a Refresh Token is available, a new Auth Token is generated when an existing Auth Token expires, and it is then updated in the integration context.
    False
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

vd-auth-start#


Obtain an access token from the API client. If Client ID and Client Secret were not passed as parameters or arguments, a new Auth Client will be created.

Base Command#

vd-auth-start

Input#

Argument NameDescriptionRequired
auth_client_nameName of Auth Client. If an excised token name will be given as argument, an error might occur.Optional
descriptionDescription of the access token.Optional
client_idClient ID for Token Authentication. If already passed as a parameter it will be prioritized by default.Optional
client_secretClient Secret for Token Authentication. If already passed as a parameter it will be prioritized by default.Optional

Context Output#

PathTypeDescription
VersaDirector.AuthClientStringAuth Client Credentials.

Command example#

!vd-auth-start auth_client_name=example_client description="example client"

Context Example#

{
"VersaDirector": {
"AuthClient": {
"client_id": "example_client_id",
"client_name": "example_client"
}
}
}

Human Readable Output#

Auth Client Created Successfully. Client ID: example_client_id, Auth Client Name: example_client.

Authentication request was successful, Auth Token was created and saved in the Integration Context. Please uncheck the 'Use Basic Authentication' in the configuration screen. To ensure the authentication is valid, run the 'vd-auth-test' command.

vd-auth-test#


Run a connectivity test to verify that the OAuth process worked.

Base Command#

vd-auth-test

Input#

There are no input arguments for this command.

Context Output#

There is no context output for this command.

Command example#

!vd-auth-test

Human Readable Output#

Auth Token Authentication method connectivity verified.

vd-predefined-application-list#


List all user predefined application objects.

Base Command#

vd-predefined-application-list

Input#

Argument NameDescriptionRequired
familyGroup type of application. Possible values are: business-system, collaboration, general-internet, media, networking.Optional
risksRisks threshold. This value must be equal to or higher than the input.Optional
tagsA comma-separated list of tags.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page. Default is 0.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.PredefinedApplication.namestringA comma-separated list of predefined applications's name.
VersaDirector.PredefinedApplication.familystringA comma-separated list of predefined applications family type.
VersaDirector.PredefinedApplication.subfamilystringPredefined sub-group family application type.
VersaDirector.PredefinedApplication.descriptionstringA comma-separated list of predefined applications description.
VersaDirector.PredefinedApplication.riskstringA comma-separated list of predefined applications risks threshold. This value is equal to or higher than the input.
VersaDirector.PredefinedApplication.productivitystringA comma-separated list of predefined applications productivity.
VersaDirector.PredefinedApplication.tagstringA comma-separated list of predefined applications tag.

Command example#

!vd-predefined-application-list limit=1

Context Example#

{
"File": {
"Comment": "Return result too large, uploaded as a file",
"EntryID": "EXAMPLE_HASH",
"Info": "text/plain",
"MD5": "EXAMPLE_HASH",
"Name": "Result file",
"SHA1": "EXAMPLE_HASH",
"SHA256": "EXAMPLE_HASH",
"SHA512": "EXAMPLE_HASH",
"SSDeep": "EXAMPLE_HASH",
"Size": 10000,
"Type": "ASCII text, with very long lines (499)"
},
"VersaDirector": {
"PredefinedApplication": [
{
"bandwidth": "1000",
"deprecated": "0",
"family": "general-internet",
"flexvnf": "N/A",
"ips": "0",
"subfamily": "web",
"tag": [
"tag1",
"tag2"
],
},
]
}
}

Human Readable Output#

Return result too large, uploaded as a file

vd-appliance-user-modified-application-list#


List all user modified predefined application objects associated with a specific organization and appliance (device).

Base Command#

vd-appliance-user-modified-application-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-namestringAppliance user modified application name.
VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-riskstringAppliance user modified application risk threshold.
VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-productivitystringAppliance user modified application productivity.
VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-timeoutstringAppliance user modified application timeout.
VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-final-with-endpointstringAppliance user modified application final endpoint.

Command example#

!vd-appliance-user-modified-application-list appliance_name=EXAMPLE_BRANCH limit=3

Human Readable Output#

Empty response has returned from vd-appliance-user-modified-application-list command. Message: Error in API call [204]

vd-template-user-modified-application-list#


List all user modified predefined application objects associated with a specific organization and template.

Base Command#

vd-template-user-modified-application-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-namestringTemplate user modified application name.
VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-riskstringTemplate user modified application risk threshold.
VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-productivitystringTemplate user modified application productivity.
VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-timeoutstringTemplate user modified application timeout.
VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-final-with-endpointstringTemplate user modified application final endpoint.

Command example#

!vd-template-user-mod-Default-Application limit=3

Context Example#

{
"VersaDirector": {
"TemplateUserModifiedApplication": {
"app-final-with-endpoint": "false",
"app-name": "NAME",
"app-productivity": "3",
"app-risk": "3",
"app-timeout": "300"
}
}
}

Human Readable Output#

User modified predefined application objects associated with EXAMPLE_CLIENT#

App - NameApp - RiskApp - ProductivityApp - TimeoutApp - Final - With - Endpoint
TEST33300false

vd-appliance-user-defined-application-list#


List all user defined application objects associated with a specific organization and appliance (device).

Base Command#

vd-appliance-user-defined-application-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.app-namestringAppliance user defined application name.
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.descriptionstringAppliance user defined application description.
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.precedencestringAppliance user defined application precedence.
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.tagstringAppliance user defined application tag.
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.riskstringAppliance user defined application risk threshold.
VersaDirector.ApplianceUserDefinedApplication.user-defined-application.familystringAppliance user defined application family.

Command example#

!vd-appliance-user-defined-application-list appliance_name=EXAMPLE_BRANCH limit=3

Human Readable Output#

Empty response has returned from vd-appliance-user-defined-application-list command. Message: Error in API call [204]

vd-template-user-defined-application-list#


List all user defined application objects associated with a specific organization and template.

Base Command#

vd-template-user-defined-application-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateUserDefinedApplication.user-defined-application.app-namestringTemplate user defined application name.
VersaDirector.TemplateUserDefinedApplication.user-defined-application.descriptionstringTemplate user defined application description.
VersaDirector.TemplateUserDefinedApplication.user-defined-application.precedencestringTemplate user defined application precedence.
VersaDirector.TemplateUserDefinedApplication.user-defined-application.tagstringTemplate user defined application tag.
VersaDirector.TemplateUserDefinedApplication.user-defined-application.riskstringTemplate user defined application risk threshold.
VersaDirector.TemplateUserDefinedApplication.user-defined-application.familystringTemplate user defined application family.

Command example#

!vd-template-user-defined-application-list template_name=EXAMPLE_CLIENT-Default-Application limit=3

Context Example#

{
"VersaDirector": {
"TemplateUserDefinedApplication": [
{
"app-match-ips": "false",
"app-name": "TestApplication",
"description": "This is a test from UI",
"family": "collaboration",
"precedence": "65",
"productivity": "3",
"risk": "3",
"subfamily": "custom",
"tag": [
"tag1",
"tag2",
]
},
{
"app-match-ips": "false",
"app-match-rules": {
"rule-name": null
},
"app-name": "TestCustomApp",
"app-timeout": "300",
"description": "Test custom app creation from API",
"family": null,
"precedence": "95",
"productivity": "5",
"risk": "5",
"subfamily": null,
"tag": "tag3"
}
]
}
}

Human Readable Output#

A comma-separated list of user defined applications objects associated with EXAMPLE_CLIENT#

App - NameDescriptionPrecedenceTagRiskFamily
TestApplicationThis is a test from UI65values: tag2, v_cloud, vs_evasive3collaboration
TestCustomAppTest custom app creation from API95tag25

vd-appliance-address-object-delete#


Delete an address object associated with a specific organization and appliance (device).

Base Command#

vd-appliance-address-object-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
object_nameAddress object name.Required

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-address-object-delete object_name=Bad-Address appliance_name=EXAMPLE_BRANCH

Human Readable Output#

Command run successfully.

vd-appliance-address-object-edit#


Edit an address object associated with a specific organization and appliance (device).

Base Command#

vd-appliance-address-object-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
object_nameAddress object name.Required
descriptionAddress object description.Optional
tagsA comma-separated list of tags.Optional
address_object_typeAddress object type. Possible values are: ipv4-prefix, ipv4-range, ipv4-wildcard-mask, ipv6-prefix, fqdn, dynamic-address.Required
object_valueObject value.Required

Context Output#

PathTypeDescription
VersaDirector.TemplateAddressObject.namestringTemplate address object name.
VersaDirector.TemplateAddressObject.tagstringTemplate Address object tag.
VersaDirector.TemplateAddressObject.descriptionstringTemplate address object description.
VersaDirector.TemplateAddressObject.ipv4-prefixstringTemplate address object IPv4 prefix
VersaDirector.TemplateAddressObject.ipv4-rangestringTemplate address object IPv4 range.
VersaDirector.TemplateAddressObject.ipv4-wildcard-maskstringTemplate address object IPv4 wildcard mask.
VersaDirector.TemplateAddressObject.ipv6-prefixstringTemplate address object IPv6 prefix.
VersaDirector.TemplateAddressObject.fqdnstringTemplate address object FQDN.
VersaDirector.TemplateAddressObject.dynamic-addressstringTemplate address object dynamic address.

Command example#

!vd-appliance-address-object-edit appliance_name=EXAMPLE_BRANCH address_object_type=fqdn object_value=test1.com,test2.com object_name=Bad-Address description="changed"

Human Readable Output#

Command run successfully. Request Body:

{'address': {'name': 'Bad-Address', 'description': 'changed', 'tag': [], 'fqdn': 'test1.com,test2.com'}}

vd-appliance-address-object-create#


Create an address object associated with a specific organization and appliance (device).

Base Command#

vd-appliance-address-object-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
object_nameAddress object name.Required
descriptionAddress object description.Required
tagsA comma-separated list of tags.Optional
address_object_typeAddress object type. Possible values are: ipv4-prefix, ipv4-range, ipv4-wildcard-mask, ipv6-prefix, fqdn, dynamic-address.Required
object_valueObject value.Required

Context Output#

PathTypeDescription
VersaDirector.TemplateAddressObject.namestringTemplate address object name.
VersaDirector.TemplateAddressObject.tagstringTemplate Address object tag.
VersaDirector.TemplateAddressObject.descriptionstringTemplate address object description.
VersaDirector.TemplateAddressObject.ipv4-prefixstringTemplate address object IPv4 prefix
VersaDirector.TemplateAddressObject.ipv4-rangestringTemplate address object IPv4 range.
VersaDirector.TemplateAddressObject.ipv4-wildcard-maskstringTemplate address object IPv4 wildcard mask.
VersaDirector.TemplateAddressObject.ipv6-prefixstringTemplate address object IPv6 prefix.
VersaDirector.TemplateAddressObject.fqdnstringTemplate address object FQDN.
VersaDirector.TemplateAddressObject.dynamic-addressstringTemplate address object dynamic address.

Command example#

!vd-appliance-address-object-create appliance_name=EXAMPLE_BRANCH address_object_type=fqdn object_value=test1.com,test2.com object_name=Bad-Address description="test"

Human Readable Output#

Command run successfully. Request Body:

{'address': {'name': 'Bad-Address', 'description': 'test', 'tag': [], 'fqdn': 'test1.com,test2.com'}}

vd-appliance-address-object-list#


List all address objects associated with a specific organization and appliance (device).

Base Command#

vd-appliance-address-object-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceAddressObject.namestringAppliance address object name.
VersaDirector.ApplianceAddressObject.descriptionstringAppliance address object description.
VersaDirector.ApplianceAddressObject.tagstringAppliance address object tag.
VersaDirector.ApplianceAddressObject.ipv4-prefixstringAppliance address object ipv4-prefix.
VersaDirector.ApplianceAddressObject.fqdnstringAppliance address object FQDN.

Command example#

!vd-appliance-address-object-list appliance_name=EXAMPLE_BRANCH limit=3

Context Example#

{
"VersaDirector": {
"ApplianceAddressObject": [
{
"ipv4-prefix": "EXAMPLE_URL/32",
"name": "Bad-Address-1",
"tag": "test"
},
{
"fqdn": "test1.com",
"name": "Bad-Address-2"
},
{
"ipv4-prefix": "EXAMPLE_URL/32",
"name": "Bad-Address-4"
}
]
}
}

Human Readable Output#

Address objects associated with EXAMPLE_CLIENT#

NameTagIpv 4- PrefixFqdn
Bad-Address-1testEXAMPLE_URL/32
Bad-Address-2test1.com
Bad-Address-4EXAMPLE_URL/32

vd-template-address-object-delete#


Delete an address object associated with a specific organization and template.

Base Command#

vd-template-address-object-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
object_nameAddress object name.Required

Context Output#

There is no context output for this command.

Command example#

!vd-template-address-object-delete template_name=EXAMPLE_CLIENT-Default-Application object_name=Bad-Address

Human Readable Output#

Command run successfully.

vd-template-address-object-edit#


Create an address object associated with a specific organization and template.

Base Command#

vd-template-address-object-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
object_nameAddress object name.Required
descriptionAddress object description.Optional
tagsA comma-separated list of tags.Optional
address_object_typeAddress object type. Possible values are: ipv4-prefix, ipv4-range, ipv4-wildcard-mask, ipv6-prefix, fqdn, dynamic-address.Required
object_valueObject value.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateAddressObject.namestringTemplate address object name.
VersaDirector.TemplateAddressObject.tagstringTemplate Address object tag.
VersaDirector.TemplateAddressObject.descriptionstringTemplate address object description.
VersaDirector.TemplateAddressObject.ipv4-prefixstringTemplate address object IPv4 prefix
VersaDirector.TemplateAddressObject.ipv4-rangestringTemplate address object IPv4 range.
VersaDirector.TemplateAddressObject.ipv4-wildcard-maskstringTemplate address object IPv4 wildcard mask.
VersaDirector.TemplateAddressObject.ipv6-prefixstringTemplate address object IPv6 prefix.
VersaDirector.TemplateAddressObject.fqdnstringTemplate address object FQDN.
VersaDirector.TemplateAddressObject.dynamic-addressstringTemplate address object dynamic address.

Command example#

!vd-template-address-object-edit template_name=EXAMPLE_CLIENT-Default-Application address_object_type=fqdn object_value=test.com object_name=Bad-Address description="changed"

Human Readable Output#

Command run successfully. Request Body:

{'address': {'name': 'Bad-Address', 'description': 'changed', 'tag': [], 'fqdn': 'test.com'}}

vd-template-address-object-create#


Create an address object associated with a specific organization and template.

Base Command#

vd-template-address-object-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
object_nameAddress object name.Required
descriptionAddress object description.Optional
tagsA comma-separated list of tags.Optional
address_object_typeAddress object type. Possible values are: ipv4-prefix, ipv4-range, ipv4-wildcard-mask, ipv6-prefix, fqdn, dynamic-address.Required
object_valueObject value.Required

Context Output#

PathTypeDescription
VersaDirector.TemplateAddressObject.namestringTemplate address object name.
VersaDirector.TemplateAddressObject.tagstringTemplate Address object tag.
VersaDirector.TemplateAddressObject.descriptionstringTemplate address object description.
VersaDirector.TemplateAddressObject.ipv4-prefixstringTemplate address object IPv4 prefix
VersaDirector.TemplateAddressObject.ipv4-rangestringTemplate address object IPv4 range.
VersaDirector.TemplateAddressObject.ipv4-wildcard-maskstringTemplate address object IPv4 wildcard mask.
VersaDirector.TemplateAddressObject.ipv6-prefixstringTemplate address object IPv6 prefix.
VersaDirector.TemplateAddressObject.fqdnstringTemplate address object FQDN.
VersaDirector.TemplateAddressObject.dynamic-addressstringTemplate address object dynamic address.

Command example#

!vd-template-address-object-create template_name=EXAMPLE_CLIENT-Default-Application address_object_type=fqdn object_value=test.com object_name=Bad-Address description="test"

Human Readable Output#

Command run successfully. Request Body:

{'address': {'name': 'Bad-Address', 'description': 'test', 'tag': [], 'fqdn': 'test.com'}}

vd-template-address-object-list#


List all address objects associated with a specific organization and template.

Base Command#

vd-template-address-object-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateAddressObject.namestringTemplate address object name.
VersaDirector.TemplateAddressObject.descriptionstringTemplate address object description.
VersaDirector.TemplateAddressObject.tagstringTemplate Address object tag.
VersaDirector.TemplateAddressObject.ipv4-prefixstringTemplate address object IPv4 prefix
VersaDirector.TemplateAddressObject.fqdnstringTemplate address object FQDN.

Command example#

!vd-template-address-object-list template_name=EXAMPLE_CLIENT-Default-Application limit=3

Context Example#

{
"VersaDirector": {
"TemplateAddressObject": [
{
"description": "None",
"ipv4-wildcard-mask": "MASK",
"name": "Bad-Address-2",
"tag": "['badAddress,veryBadAddress']"
},
{
"description": "None",
"ipv4-prefix": "1.1.1.1",
"name": "Bad-Address-1",
"tag": "[]"
},
{
"description": "test bad addrees 4",
"fqdn": "test4.com",
"name": "Bad-Address-4",
"tag": "[]"
}
]
}
}

Human Readable Output#

Address objects associated with EXAMPLE_CLIENT#

NameDescriptionTagIpv 4- PrefixFqdnIpv 4- Wildcard - Mask
Bad-Address-2None['badAddress,veryBadAddress']MASK
Bad-Address-1None[]1.1.1.1
Bad-Address-4test bad addrees 4[]test4.com

vd-appliance-sdwan-policy-rule-delete#


Delete an SDWAN policy rule associated with a specific appliance (device).

Base Command#

vd-appliance-sdwan-policy-rule-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
sdwan_policy_nameName of the SDWAN policy.Required
rule_nameName of the rule.Required

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-sdwan-policy-rule-delete appliance_name=EXAMPLE_BRANCH rule_name=test_rule sdwan_policy_name=Default-Policy

Human Readable Output#

Command run successfully.

vd-appliance-sdwan-policy-rule-edit#


Edit an SDWAN policy rule associated with a specific appliance (device).

Base Command#

vd-appliance-sdwan-policy-rule-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
sdwan_policy_nameName of the SDWAN policy.Required
custom_rule_jsonAllows the use of the Custom SDWAN Rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
custom_url_categoriesA comma-separated list of custom URL categories.Optional
forwarding_actionForwarding action. Possible values are: allow, deny.Required
nexthop_ipNexthop IP.Optional
routing_instanceRouting instance.Optional
forwarding_profileForwarding profile.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

vd-appliance-sdwan-policy-rule-create#


Create an SDWAN policy rule associated with a specific appliance (device).

Base Command#

vd-appliance-sdwan-policy-rule-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
sdwan_policy_nameName of the SDWAN policy.Required
custom_rule_jsonAllows the use of the Custom SDWAN Rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
custom_url_categoriesA comma-separated list of custom URL categories.Optional
forwarding_actionForwarding action. Possible values are: allow, deny.Required
nexthop_ipNexthop IP.Optional
routing_instanceRouting instance.Optional
forwarding_profileForwarding profile.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-sdwan-policy-rule-create appliance_name=EXAMPLE_BRANCH sdwan_policy_name=Default-Policy rule_name=test_rule forwarding_action=deny description="test"

Human Readable Output#

Command run successfully. Request Body:

{'rule': {'name': 'test_rule', 'description': 'test', 'tag': [], 'rule-disable': 'false', 'match': {'source': {'zone': {}, 'address': {'address-list': []}, 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': []}}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'profile-default': 'true', 'rate-limit': '10'}, 'action': 'deny', 'tcp-optimization': {}}, 'monitor': {}}}

vd-appliance-sdwan-policy-rule-list#


List all SDWAN policy rules associated with a specific appliance (device).

Base Command#

vd-appliance-sdwan-policy-rule-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
sdwan_policy_nameName of the SDWAN policy.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of objects to return.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceSdwanPolicyRule.namestringPolicy rule name
VersaDirector.ApplianceSdwanPolicyRule.descriptionstringPolicy rule description
VersaDirector.ApplianceSdwanPolicyRule.rule-disablestringRule is disabled
VersaDirector.ApplianceSdwanPolicyRule.set.actionstringRule action

Command example#

!vd-appliance-sdwan-policy-rule-list appliance_name=EXAMPLE_BRANCH sdwan_policy_name=Default-Policy limit=3

Context Example#

{
"VersaDirector": {
"ApplianceSdwanPolicyRule": [
{
"match": {
"source": {
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": "Test_Cat"
}
},
"name": "Test",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"rate-limit": "10"
}
}
},
{
"match": {
"source": {
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": "Test_Cat"
}
},
"name": "Block-custom-URL-category-rule",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"rate-limit": "10"
}
}
}
]
}
}

Human Readable Output#

SD-WAN policy rules associated with EXAMPLE_CLIENT#

NameRule - Disable
Tesrtfalse
Block-custom-URL-category-rulefalse

vd-appliance-sdwan-policy-list#


List all SDWAN policies associated with a specific organization and appliance (device).

Base Command#

vd-appliance-sdwan-policy-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceSdwanPolicy.addressstringAppliance SDWAN policy address.
VersaDirector.ApplianceSdwanPolicy.rule-disablestringAppliance Sdwan policy Rule disabled.
VersaDirector.ApplianceSdwanPolicy.matchstringAppliance SDWAN policy set Matching objects.
VersaDirector.ApplianceSdwanPolicy.setstringAppliance SDWAN policy set.

Command example#

!vd-appliance-sdwan-policy-list appliance_name=EXAMPLE_BRANCH limit=3

Context Example#

{
"VersaDirector": {
"ApplianceSdwanPolicy": {
"name": "Default-Policy",
"rules": {
"rule": [
{
"name": "TEST"
},
{
"name": "Block-custom-URL-category-rule"
}
]
}
}
}
}

Human Readable Output#

SD-WAN policies associated with EXAMPLE_CLIENT#

NameRules
Default-Policyrule:
- name: TEST
- name: Block-custom-URL-category-rule

vd-template-sdwan-policy-rule-delete#


Delete an SDWAN policy rule associated with a specific template.

Base Command#

vd-template-sdwan-policy-rule-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
sdwan_policy_nameName of the SDWAN policy.Required
rule_nameName of the rule.Required

Context Output#

There is no context output for this command.

Command example#

!vd-template-sdwan-policy-rule-delete template_name=EXAMPLE_CLIENT-Default-Application sdwan_policy_name=Default-Policy rule_name=test_rule

Human Readable Output#

Command run successfully.

vd-template-sdwan-policy-rule-edit#


Edit an SDWAN policy rule associated with a specific appliance (device).

Base Command#

vd-template-sdwan-policy-rule-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
sdwan_policy_nameName of the SDWAN policy.Required
custom_rule_jsonAllows the use of the Custom SDWAN Rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
custom_url_categoriesA comma-separated list of custom URL categories.Optional
forwarding_actionForwarding action. Possible values are: allow, deny.Required
nexthop_ipNexthop IP.Optional
routing_instanceRouting instance.Optional
forwarding_profileForwarding profile.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

vd-template-sdwan-policy-rule-create#


Create an SDWAN policy rule associated with a specific template.

Base Command#

vd-template-sdwan-policy-rule-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
sdwan_policy_nameName of the SDWAN policy.Required
custom_rule_jsonAllows the use of the Custom SDWAN Rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
custom_url_categoriesA comma-separated list of custom URL categories.Optional
forwarding_actionForwarding action. Possible values are: allow, deny.Required
nexthop_ipNexthop IP.Optional
routing_instanceRouting instance.Optional
forwarding_profileForwarding profile.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-template-sdwan-policy-rule-create template_name=EXAMPLE_CLIENT-Default-Application sdwan_policy_name=Default-Policy rule_name=test_rule forwarding_action=deny

Human Readable Output#

Command run successfully. Request Body:

{'rule': {'name': 'test_rule', 'description': '', 'tag': [], 'rule-disable': 'false', 'match': {'source': {'zone': {}, 'address': {'address-list': []}, 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': []}}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'profile-default': 'true', 'rate-limit': '10'}, 'action': 'deny', 'tcp-optimization': {}}, 'monitor': {}}}

Command example#

!vd-template-sdwan-policy-rule-create template_name=EXAMPLE_CLIENT-Default-Application sdwan_policy_name=Default-Policy rule_name=test_rule forwarding_action=deny

Human Readable Output#

Object already exists. Request Body:

(None, 'Not available.')

vd-template-sdwan-policy-rule-list#


List all SDWAN policy rules associated with a specific template.

Base Command#

vd-template-sdwan-policy-rule-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
sdwan_policy_nameName of the SDWAN policy.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.namestringTemplate SDWAN policy group name
VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.rulesstringTemplate SDWAN policy group rules

Command example#

!vd-template-sdwan-policy-rule-list template_name=EXAMPLE_CLIENT-Default-Application sdwan_policy_name=Default-Policy limit=3

Context Example#

{
"VersaDirector": {
"TemplateSdwanPolicyRule": [
{
"match": {
"application": {
"predefined-filter-list": "VOIP"
}
},
"name": "Voice",
"set": {
"action": "allow",
"forwarding-profile": "Rule-Voice-FP"
}
},
{
"match": {
"application": {
"predefined-filter-list": "Audio-Video-Streaming"
}
},
"name": "Audio-Video-Streaming",
"set": {
"action": "allow",
"forwarding-profile": "Rule-Audio-Video-Streaming-FP"
}
},
{
"match": {
"application": {
"predefined-group-list": "ADP-Apps"
}
},
"name": "ADP-Apps",
"set": {
"action": "allow",
"forwarding-profile": "Rule-ADP-Apps-FP"
}
}
]
}
}

Human Readable Output#

SD-WAN policy rules associated with EXAMPLE_CLIENT#

NameMatchSet
Voiceapplication:
predefined-filter-list: VOIP
action: allow
forwarding-profile: Rule-Voice-FP
Audio-Video-Streamingapplication:
predefined-filter-list: Audio-Video-Streaming
action: allow
forwarding-profile: Rule-Audio-Video-Streaming-FP
ADP-Appsapplication:
predefined-group-list: ADP-Apps
action: allow
forwarding-profile: Rule-ADP-Apps-FP

vd-template-sdwan-policy-list#


List all SDWAN policies associated with a specific organization and template.

Base Command#

vd-template-sdwan-policy-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.namestringTemplate SDWAN policy group name
VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.rulesstringTemplate SDWAN policy group rules

Command example#

!vd-template-sdwan-policy-list template_name=EXAMPLE_CLIENT-Default-Application limit=3

Context Example#

{
"VersaDirector": {
"TemplateSdwanPolicy": {
"collection": {
"sdwan-policy-group": {
"name": "Default-Policy",
"rules": {
"rule": [
{
"name": "Voice"
},
{
"name": "Audio-Video-Streaming"
},
{
"name": "ADP-Apps"
},
{
"name": "Amazon-Apps"
},
{
"name": "Box-Apps"
},
{
"name": "Citrix-Apps"
},
{
"name": "Concur-Apps"
},
{
"name": "Docusign-Apps"
},
{
"name": "Dropbox-Apps"
},
{
"name": "IBM-Apps"
},
{
"name": "Intuit-Apps"
},
{
"name": "Jira-Apps"
},
{
"name": "Office365-Apps"
},
{
"name": "Oracle-Apps"
},
{
"name": "SAP-Apps"
},
{
"name": "Salesforce-Apps"
},
{
"name": "Zendesk-Apps"
},
{
"name": "Zoho-Apps"
},
{
"name": "SaaS-Applications"
},
{
"name": "Database"
},
{
"name": "Business-Traffic"
},
{
"name": "Google-Apps"
},
{
"name": "Conferencing-Apps"
},
{
"name": "SoftwareUpdates"
},
{
"name": "File-Transfer"
},
{
"name": "Adobe-Apps"
},
{
"name": "Advertising"
},
{
"name": "Gaming"
},
{
"name": "P2P"
},
{
"name": "Social-Media"
},
{
"name": "Block-custom-URL-category-rule"
},
]
}
}
}
}
}
}

Human Readable Output#

SD-WAN policies associated with EXAMPLE_CLIENT#

NameRules
Default-Policyrule:
- name: Voice
- name: Audio-Video-Streaming
- name: ADP-Apps
- name: Amazon-Apps
- name: Box-Apps
- name: Citrix-Apps
- name: Concur-Apps
- name: Docusign-Apps
- name: Dropbox-Apps
- name: IBM-Apps
- name: Intuit-Apps
- name: Jira-Apps
- name: Office365-Apps
- name: Oracle-Apps
- name: SAP-Apps
- name: Salesforce-Apps
- name: Zendesk-Apps
- name: Zoho-Apps
- name: SaaS-Applications
- name: Database
- name: Business-Traffic
- name: Google-Apps
- name: Conferencing-Apps
- name: SoftwareUpdates
- name: File-Transfer
- name: Adobe-Apps
- name: Advertising
- name: Gaming
- name: P2P
- name: Social-Media
- name: Block-custom-URL-category-rule

vd-appliance-access-policy-rule-delete#


Delete an access policy configuration (NGFW) rule associated with a specific appliance (device).

Base Command#

vd-appliance-access-policy-rule-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
access_policy_nameAccess policy name.Required
rule_nameName of the rule.Required

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-access-policy-rule-delete rule_name=test_rule_new1 appliance_name=EXAMPLE_BRANCH access_policy_name=Test_Policy

Human Readable Output#

Command run successfully.

vd-appliance-access-policy-rule-edit#


Edit access policy configuration (NGFW) rule associated with a specific appliance (device). Important note - the data provided in the request overwrites the existing rule settings.

Base Command#

vd-appliance-access-policy-rule-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
access_policy_nameAccess policy name.Required
custom_rule_jsonAllows the use of the Custom Access policy rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-access-policy-rule-edit rule_name=test_rule_new1 appliance_name=EXAMPLE_BRANCH access_policy_name=Test_Policy description="test rule changed" source_address_objects="Bad-Address-1" destination_address_objects="Bad-Address-2"

Human Readable Output#

Command run successfully. Request Body:

{'access-policy': {'name': 'test_rule_new1', 'description': 'test rule changed', 'rule-disable': 'false', 'tag': [], 'match': {'source': {'zone': {}, 'address': {'address-list': ['Bad-Address-1'], 'negate': ''}, 'site-name': [], 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': ['Bad-Address-2'], 'negate': ''}, 'site-name': []}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'options': {'send-pcap-data': {'enable': False}}}, 'action': 'deny', 'tcp-session-keepalive': 'disabled'}}}

vd-appliance-access-policy-rule-create#


Create an access policy configuration (NGFW) rule associated with a specific appliance (device).

Base Command#

vd-appliance-access-policy-rule-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
access_policy_nameAccess policy name.Required
custom_rule_jsonAllows the use of the Custom Access policy rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Required
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Required
destination_address_objectsA comma-separated list of destination address objects.Required
url_reputationA comma-separated list of URL reputations.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-appliance-access-policy-rule-create rule_name=test_rule_new1 appliance_name=EXAMPLE_BRANCH access_policy_name=Test_Policy description="test rule" source_address_objects="Bad-Address-1" destination_address_objects="Bad-Address-2"

Human Readable Output#

Command run successfully. Request Body:

{'access-policy': {'name': 'test_rule_new1', 'description': 'test rule', 'rule-disable': 'false', 'tag': [], 'match': {'source': {'zone': {}, 'address': {'address-list': ['Bad-Address-1'], 'negate': ''}, 'site-name': [], 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': ['Bad-Address-2'], 'negate': ''}, 'site-name': []}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'options': {'send-pcap-data': {'enable': False}}}, 'action': 'deny', 'tcp-session-keepalive': 'disabled'}}}

vd-appliance-access-policy-rule-list#


List all access policy configuration (NGFW) rules associated with a specific appliance.

Base Command#

vd-appliance-access-policy-rule-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
access_policy_nameAccess policy name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceAccessPolicyRule.namestringAppliance access policy rule name
VersaDirector.ApplianceAccessPolicyRule.descriptionstringAppliance access policy rule description
VersaDirector.ApplianceAccessPolicyRule.tagstringAppliance access policy rule tag
VersaDirector.ApplianceAccessPolicyRule.rule-disablestringAppliance access policy rule disabled

Command example#

!vd-appliance-access-policy-rule-list appliance_name=EXAMPLE_BRANCH access_policy_name=Test_Policy limit=3

Context Example#

{
"VersaDirector": {
"ApplianceAccessPolicyRule": {
"collection": {
"access-policy": [
{
"description": "test rule",
"match": {
"destination": {
"address": {
"address-list": "Bad-Address-2",
"negate": null
}
},
"source": {
"address": {
"address-list": "Bad-Address-1",
"negate": null
},
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
}
},
"name": "Test_Rule",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"options": {
"send-pcap-data": {
"enable": "false"
}
}
},
"tcp-session-keepalive": "disabled"
}
},
{
"match": {
"destination": {
"address": {
"address-list": "Bad-Address-2",
"negate": null
}
},
"source": {
"address": {
"address-list": [
"Bad-Address-1",
"Bad-Address-2"
],
"negate": null
},
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": "Test_Cat"
},
"url-reputation": {
"predefined": "high_risk"
}
},
"name": "Block-custom-URL-category-rulethree",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"options": {
"send-pcap-data": {
"enable": "false"
}
}
},
"tcp-session-keepalive": "disabled"
},
"tag": [
"API",
"test"
]
}
]
}
}
}
}

Human Readable Output#

Access policies associated with EXAMPLE_CLIENT#

NameDescriptionTagRule - Disable
Test_Ruletest rulefalse
Block-custom-URL-category-rulethreevalues: API, testfalse

vd-appliance-access-policy-list#


List all access policies associated with a specific organization and appliance (device).

Base Command#

vd-appliance-access-policy-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceAccessPolicy.namestringAccess policy name.
VersaDirector.ApplianceAccessPolicy.rulesstringAccess policy rules

Command example#

!vd-appliance-access-policy-list appliance_name=EXAMPLE_BRANCH limit=3

Context Example#

{
"VersaDirector": {
"ApplianceAccessPolicy": {
"collection": {
"access-policy-group": {
"description": "This is a test",
"name": "Test_Policy",
"rules": {
"access-policy": [
{
"name": "Test_Rule"
},
{
"name": "Block-custom-URL-category-rulethree"
}
]
}
}
}
}
}
}

Human Readable Output#

Access policies associated with EXAMPLE_CLIENT#

NameRules
Test_Policyaccess-policy:
- name: Test_Rule
- name: Block-custom-URL-category-rulethree

vd-template-access-policy-rule-delete#


Delete an access policy configuration (NGFW) rule associated with a specific template.

Base Command#

vd-template-access-policy-rule-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
access_policy_nameAccess policy name.Required
rule_nameName of the rule.Required

Context Output#

There is no context output for this command.

Command example#

!vd-template-access-policy-rule-delete rule_name=test_rule template_name=EXAMPLE_CLIENT-Test-NGFW access_policy_name=Default-Policy

Human Readable Output#

Command run successfully.

vd-template-access-policy-rule-edit#


Edit access policy configuration (NGFW) rule associated with a specific template. Important note - the data provided in the request overwrites the existing rule settings.

Base Command#

vd-template-access-policy-rule-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
access_policy_nameAccess policy name.Required
custom_rule_jsonAllows the use of the Custom Access policy rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionSDWAN policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-template-access-policy-rule-edit template_name=EXAMPLE_CLIENT-Test-NGFW rule_name=test_rule access_policy_name=Default-Policy

Human Readable Output#

Command run successfully. Request Body:

{'access-policy': {'name': 'test_rule', 'description': '', 'rule-disable': 'false', 'tag': [], 'match': {'source': {'zone': {}, 'address': {'address-list': [], 'negate': ''}, 'site-name': [], 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': [], 'negate': ''}, 'site-name': []}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'options': {'send-pcap-data': {'enable': False}}}, 'action': 'deny', 'tcp-session-keepalive': 'disabled'}}}

vd-template-access-policy-rule-create#


Create an access policy configuration (NGFW) rule associated with a specific template.

Base Command#

vd-template-access-policy-rule-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
access_policy_nameAccess policy name.Required
custom_rule_jsonAllows the use of the Custom Access policy rule JSON template. All of the arguments listed below will be overridden. For an example, see the integration documentation.Optional
rule_nameName of the rule.Required
descriptionAccess policy description.Optional
tagsA comma-separated list of tags.Optional
source_address_objectsA comma-separated list of source address objects.Optional
destination_address_objectsA comma-separated list of destination address objects.Optional
url_reputationA comma-separated list of URL reputations.Optional
predefined_applicationA comma-separated list of predefined applications.Optional
user_defined_applicationA comma-separated list of user defined applications.Optional

Context Output#

There is no context output for this command.

Command example#

!vd-template-access-policy-rule-create template_name=EXAMPLE_CLIENT-Test-NGFW rule_name=test_rule access_policy_name=Default-Policy

Human Readable Output#

Command run successfully. Request Body:

{'access-policy': {'name': 'test_rule', 'description': '', 'rule-disable': 'false', 'tag': [], 'match': {'source': {'zone': {}, 'address': {'address-list': [], 'negate': ''}, 'site-name': [], 'user': {'user-type': 'any', 'local-database': {'status': 'disabled'}, 'external-database': {'status': 'disabled'}}}, 'destination': {'zone': {}, 'address': {'address-list': [], 'negate': ''}, 'site-name': []}, 'application': {'predefined-application-list': [], 'user-defined-application-list': []}, 'url-category': {'user-defined': []}, 'url-reputation': {'predefined': []}, 'ttl': {}}, 'set': {'lef': {'event': 'never', 'options': {'send-pcap-data': {'enable': False}}}, 'action': 'deny', 'tcp-session-keepalive': 'disabled'}}}

vd-template-access-policy-rule-list#


List all access policy configuration (NGFW) rules associated with a specific template.

Base Command#

vd-template-access-policy-rule-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
access_policy_nameAccess policy name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateAccessPolicy.namestringTemplate access policy name
VersaDirector.TemplateAccessPolicy.descriptionstringTemplate access policy description
VersaDirector.TemplateAccessPolicy.tagstringTemplate access policy tag
VersaDirector.TemplateAccessPolicy.rule-disablestringTemplate access policy disabled

Command example#

!vd-template-access-policy-rule-list template_name=EXAMPLE_CLIENT-Test-NGFW access_policy_name=Default-Policy limit=3

Context Example#

{
"VersaDirector": {
"TemplateAccessPolicyRule": {
"collection": {
"access-policy": [
{
"match": {
"source": {
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": [
"Danil_Test_API_again",
"Danil_Test_Three"
]
}
},
"name": "Block-custom-URL-category-rule two",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"options": {
"send-pcap-data": {
"enable": "false"
}
}
},
"tcp-session-keepalive": "disabled"
}
},
{
"description": "Some description",
"match": {
"application": {
"predefined-group-list": "Box-Apps"
},
"destination": {
"address": {
"negate": null
}
},
"source": {
"address": {
"address-list": [
"Bad-Address-1",
"Bad-Address-2"
],
"negate": null
},
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": "Danil_Test_API_again"
},
"url-reputation": {
"predefined": "high_risk"
}
},
"name": "test_rule_UI",
"rule-disable": "false",
"set": {
"action": "allow",
"lef": {
"event": "never",
"options": {
"send-pcap-data": {
"enable": "false"
}
}
},
"tcp-session-keepalive": "disabled"
},
"tag": "test"
},
{
"description": null,
"match": {
"application": {
"predefined-application-list": "[]",
"user-defined-application-list": "[]"
},
"destination": {
"address": {
"address-list": "[]",
"negate": null
}
},
"source": {
"address": {
"address-list": "[]",
"negate": null
},
"user": {
"external-database": {
"status": "disabled"
},
"local-database": {
"status": "disabled"
},
"user-type": "any"
}
},
"url-category": {
"user-defined": "[]"
},
"url-reputation": {
"predefined": "[]"
}
},
"name": "rule",
"rule-disable": "false",
"set": {
"action": "deny",
"lef": {
"event": "never",
"options": {
"send-pcap-data": {
"enable": "false"
}
}
},
"tcp-session-keepalive": "disabled"
},
"tag": "[]"
}
]
}
}
}
}

Human Readable Output#

Access policies associated with EXAMPLE_CLIENT#

NameDescriptionTagRule - Disable
Block-custom-URL-category-rule twofalse
test_rule_UISome descriptiontestfalse
rule[]false

vd-template-access-policy-list#


List all access policies associated with a specific organization and template.

Base Command#

vd-template-access-policy-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateAccessPolicy.namestringTemplate access policy name
VersaDirector.TemplateAccessPolicy.rulesstringAccess policy rules

Command example#

!vd-template-access-policy-list template_name="EXAMPLE_CLIENT-Test-NGFW" limit=3

Context Example#

{
"VersaDirector": {
"TemplateAccessPolicy": {
"collection": {
"access-policy-group": {
"name": "Default-Policy",
"rules": {
"access-policy": [
{
"name": "Block-custom-URL-category-rule two"
},
{
"name": "test_rule_UI"
},
{
"name": "rule"
},
{
"name": "Block-custom-URL-category-rule 555"
},
{
"name": "Block-custom-URL-category-rule three"
}
]
}
}
}
}
}
}

Human Readable Output#

Access policies associated with EXAMPLE_CLIENT#

NameRules
Default-Policyaccess-policy:
- name: Block-custom-URL-category-rule two
- name: test_rule_UI
- name: rule
- name: Block-custom-URL-category-rule 555
- name: Block-custom-URL-category-rule three

vd-appliance-custom-url-category-delete#


Delete a custom URL category associated with a specific appliance (device).

Base Command#

vd-appliance-custom-url-category-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
url_category_nameURL category name.Required

Context Output#

PathTypeDescription
VersaDirector.ApplianceCustomUrlCategory.category-namestringAppliance custom URL category category name.
VersaDirector.ApplianceCustomUrlCategory.category-descriptionstringAppliance custom URL category description.
VersaDirector.ApplianceCustomUrlCategory.content.confidencenumberAppliance custom URL category confidence threshold.
VersaDirector.ApplianceCustomUrlCategory.content.urlsstringAppliance custom URL category A comma-separated list of URLs.

Command example#

!vd-appliance-custom-url-category-delete appliance_name=EXAMPLE_BRANCH url_category_name="category_example"

Human Readable Output#

Command run successfully.

vd-appliance-custom-url-category-edit#


Edit a custom URL category associated with a specific appliance (device). Important note - the data provided in the request overwrites the existing object.

Base Command#

vd-appliance-custom-url-category-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
url_category_nameURL category name.Required
descriptionCustom URL category description.Required
confidenceConfidence threshold.Required
urlsA comma-separated list of URLs.Optional
url_reputationA comma-separated list of URL reputations.Optional
patternsA comma-separated list of patterns.Optional
pattern_reputationA comma-separated list of pattern reputations.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceCustomUrlCategory.category-namestringAppliance custom URL category category name.
VersaDirector.ApplianceCustomUrlCategory.category-descriptionstringAppliance custom URL category description.
VersaDirector.ApplianceCustomUrlCategory.content.confidencenumberAppliance custom URL category confidence threshold.
VersaDirector.ApplianceCustomUrlCategory.content.urlsstringAppliance custom URL category A comma-separated list of URLs.

vd-appliance-custom-url-category-create#


Create a custom URL category associated with a specific appliance (device).

Base Command#

vd-appliance-custom-url-category-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
url_category_nameURL category name.Required
descriptionCustom URL category description.Required
confidenceConfidence threshold.Required
urlsA comma-separated list of URLs.Optional
url_reputationA comma-separated list of URL reputations.Optional
patternsA comma-separated list of patterns.Optional
pattern_reputationA comma-separated list of pattern reputations.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceCustomUrlCategory.content.category-namestringAppliance custom url category name.
VersaDirector.ApplianceCustomUrlCategory.content.category-descriptionstringAppliance custom URL category description.
VersaDirector.ApplianceCustomUrlCategory.content.confidencenumberAppliance custom URL category confidence threshold.
VersaDirector.ApplianceCustomUrlCategory.content.urlsstringAppliance custom URL category A comma-separated list of URLs.

Command example#

!vd-appliance-custom-url-category-create appliance_name=EXAMPLE_BRANCH description="description example" url_category_name="category_example" confidence=80

Human Readable Output#

Command run successfully. Request Body:

{'url-category': {'category-name': 'category_example', 'category-description': 'description example', 'confidence': '80', 'urls': {'strings': [], 'patterns': []}}}

Command example#

!vd-appliance-custom-url-category-create appliance_name=EXAMPLE_BRANCH description="description example" url_category_name="category_example" confidence=90

Human Readable Output#

Object already exists. Request Body:

(None, 'Not available.')

vd-appliance-custom-url-category-list#


List all custom URL categories associated with a specific appliance or get a specific custom URL category.

Base Command#

vd-appliance-custom-url-category-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
appliance_nameAppliance name.Required
url_category_nameURL category name.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplianceCustomUrlCategory.category-namestringAppliance custom url category name.
VersaDirector.ApplianceCustomUrlCategory.content.category-descriptionstringAppliance custom URL category description.
VersaDirector.ApplianceCustomUrlCategory.content.confidencenumberAppliance custom URL category confidence threshold.
VersaDirector.ApplianceCustomUrlCategory.content.urlsstringAppliance custom URL category A comma-separated list of URLs.

Command example#

!vd-appliance-custom-url-category-list appliance_name=EXAMPLE_BRANCH limit=3

Context Example#

{
"VersaDirector": {
"ApplianceCustomUrlCategory": {
"collection": {
"url-category": {
"category-description": "Test",
"category-name": "Test_Cat",
"confidence": "95",
"urls": {
"patterns": {
"pattern-value": "%.test2.ru"
},
"strings": {
"string-value": "hxxps://test1.ru"
}
}
}
}
}
}
}

Human Readable Output#

Application Service Appliances associated with EXAMPLE_CLIENT#

Category - NameCategory - DescriptionConfidenceUrls
Test_CatTest95strings:
string-value: hxxps://test1.ru
patterns:
pattern-value: %.test2.ru

vd-template-custom-url-category-delete#


Delete a custom URL category associated with a specific template.

Base Command#

vd-template-custom-url-category-delete

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
url_category_nameURL category name.Required

Context Output#

PathTypeDescription
VersaDirector.TemplateCustomUrlCategory.category-namestringTemplate custom URL category name.
VersaDirector.TemplateCustomUrlCategory.category-descriptionstringTemplate custom URL category description.
VersaDirector.TemplateCustomUrlCategory.content.confidencenumberTemplate custom URL category confidence threshold.
VersaDirector.TemplateCustomUrlCategory.content.urlsstringTemplate custom URL category A comma-separated list of URLs.

Command example#

!vd-template-custom-url-category-delete template_name=EXAMPLE_CLIENT-Default-Application url_category_name="category_example"

Human Readable Output#

Command run successfully.

vd-template-custom-url-category-edit#


Edit a custom URL category associated with a specific template. Important note - the data provided in the request overwrites the existing object.

Base Command#

vd-template-custom-url-category-edit

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
url_category_nameURL category name.Required
descriptionCustom URL category description.Required
confidenceConfidence threshold.Required
urlsA comma-separated list of URLs.Optional
url_reputationA comma-separated list of URL reputations.Optional
patternsA comma-separated list of patterns.Optional
pattern_reputationA comma-separated list of pattern reputations.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateCustomUrlCategory.category-namestringTemplate custom URL category name.
VersaDirector.ApplicationServiceTemplate.content.category-descriptionstringTemplate custom URL category description.
VersaDirector.ApplicationServiceTemplate.content.confidencenumberTemplate custom URL category confidence threshold.
VersaDirector.ApplicationServiceTemplate.content.urlsstringTemplate custom URL category URLs.

Command example#

!vd-template-custom-url-category-edit template_name=EXAMPLE_CLIENT-Default-Application description="description example" url_category_name="category_example" confidence=90

Human Readable Output#

Command run successfully. Request Body:

{'url-category': {'category-name': 'category_example', 'category-description': 'description example', 'confidence': '90', 'urls': {'strings': [], 'patterns': []}}}

vd-template-custom-url-category-create#


Create a custom URL category associated with a specific template.

Base Command#

vd-template-custom-url-category-create

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
url_category_nameURL category name.Required
descriptionCustom URL category description.Required
confidenceConfidence threshold.Required
urlsA comma-separated list of URLs.Optional
url_reputationA comma-separated list of URL reputations.Optional
patternsA comma-separated list of patterns.Optional
pattern_reputationA comma-separated list of pattern reputations.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateCustomUrlCategory.category-namestringTemplate custom URL category name.
VersaDirector.ApplicationServiceTemplate.content.category-descriptionstringTemplate custom url category category description.
VersaDirector.ApplicationServiceTemplate.content.confidencenumberTemplate custom URL category confidence threshold.
VersaDirector.ApplicationServiceTemplate.content.urlsstringTemplate custom URL category URLs.

Command example#

!vd-template-custom-url-category-create template_name=EXAMPLE_CLIENT-Default-Application description="description example" url_category_name="category_example" confidence=80

Human Readable Output#

Object created successfully.

vd-template-custom-url-category-list#


List all custom URL categories associated with a specific template or get a specific custom URL category.

Base Command#

vd-template-custom-url-category-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
template_nameTemplate name.Required
url_category_nameURL category name.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
url_category_nameURL category name.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateCustomUrlCategory.category-namestringTemplate custom URL category name.
VersaDirector.ApplicationServiceTemplate.content.category-descriptionstringTemplate custom url category category description.
VersaDirector.ApplicationServiceTemplate.content.confidencenumberTemplate custom URL category confidence threshold.
VersaDirector.ApplicationServiceTemplate.content.urlsstringTemplate custom URL category URLs.

Command example#

!vd-template-custom-url-category-list template_name=EXAMPLE_CLIENT-Default-Application limit=3

Context Example#

{
"VersaDirector": {
"TemplateCustomUrlCategory": {
"collection": {
"url-category": [
{
"category-description": "Some description for testing, and now editing",
"category-name": "category example1",
"confidence": "90",
"urls": {
"patterns": {
"pattern-value": ".*.testurl.com"
},
"strings": {
"string-value": "hxxps://test.ru"
}
}
},
{
"category-description": "Some description for testing, and now editing",
"category-name": "category example2",
"confidence": "5",
"urls": {
"patterns": [
{
"pattern-value": ".*.testurl.com"
},
{
"pattern-value": ".*.testurl2.com"
}
],
"strings": [
{
"string-value": "hxxps://test1.ru"
},
{
"string-value": "hxxps://test2.ru"
}
]
}
},
{
"category-description": "description example",
"category-name": "category example9",
"confidence": "80",
"urls": {
"patterns": {
"pattern-value": "[]"
},
"strings": {
"string-value": "[]"
}
}
}
]
}
}
}
}

Human Readable Output#

Application Service Templates associated with EXAMPLE_CLIENT#

Category - NameCategory - DescriptionConfidenceUrls
category example1Some description for testing, and now editing90strings:
string-value: hxxps://test.ru
patterns:
pattern-value: .*.testurl.com
category example2Some description for testing, and now editing5strings:
- string-value: hxxps://test1.ru
- string-value: hxxps://test2.ru
patterns:
- pattern-value: .*.testurl.com
- pattern-value: .*.testurl2.com
category example9description example80strings:
string-value: []
patterns:
pattern-value: []

vd-template-change-commit#


Commit a specific template change to an appliance/s (devices). This will trigger a task to make the commit, and then it will be polled to retrieve the status until complete, and the status will be presented.

Base Command#

vd-template-change-commit

Input#

Argument NameDescriptionRequired
template_nameNew template name for the device.Required
appliancesA comma-separated list of devices the change will be committed to.Required
modeCommit mode to specified devices. Possible values are: overwrite, merge, forced_merge.Required
task_idTask ID.Optional
hide_polling_outputWhether to hide the polling result (automatically filled by polling).Optional
rebootReboot devices after change is committed (true/false).Required

Context Output#

PathTypeDescription
VersaDirector.Commit.versa-tasks.idstringTask ID.
VersaDirector.Commit.versa-tasks.task-descriptionstringTask description.
VersaDirector.Commit.versa-tasks.userstringTask user.
VersaDirector.Commit.task-statusstringTask status.
VersaDirector.Commit.versa-tasks.progressmessagestringTask progress message.

Command example#

!vd-template-change-commit template_name=EXAMPLE_CLIENT-Test-NGFW appliances=EXAMPLE_BRANCH mode=merge reboot=false

Human Readable Output#

Fetching Results:

vd-application-service-template-list#


List all application service templates. Can be filtered by organization or a keyword search.

Base Command#

vd-application-service-template-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
keywordKeyword by which to search.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.ApplicationServiceTemplate.createDatestringDate the application service template was created.
VersaDirector.ApplicationServiceTemplate.modifyDatestringDate the application service template was modified.
VersaDirector.ApplicationServiceTemplate.content.lastUpdatedBystringBy whom the application service template was last updated.
VersaDirector.ApplicationServiceTemplate.content.namestringApplication service template content name.
VersaDirector.ApplicationServiceTemplate.content.organizationstringApplication service template associated organization.
VersaDirector.ApplicationServiceTemplate.content.statusstringApplication service template status.

Command example#

!vd-application-service-template-list limit=3

Context Example#

{
"VersaDirector": {
"ApplicationServiceTemplate": {
"content": [
{
"createDate": "2021-08-26 18:02:44",
"lastUpdatedBy": "EXAMPLE_USER",
"modifyDate": "2021-08-26 18:02:48",
"name": "EXAMPLE_CLIENT-Default-Application",
"organization": "EXAMPLE_CLIENT",
"status": "DEPLOYED"
}
],
"empty": false,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 1,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 3,
"paged": true,
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"unpaged": false
},
"size": 3,
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"totalElements": 1,
"totalPages": 1
}
}
}

Human Readable Output#

Application Service Templates associated with EXAMPLE_CLIENT#

Create DateModify DateLast Updated ByNameOrganizationStatus
2021-08-26 18:02:442021-08-26 18:02:48EXAMPLE_USEREXAMPLE_CLIENT-Default-ApplicationEXAMPLE_CLIENTDEPLOYED

vd-datastore-template-list#


List all templates associated with a specific datastore. As a best practice, we do not recommend applying rules to datastore templates. Instead, use devices/service/application templates.

Base Command#

vd-datastore-template-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.DataStoreTemplate.namestringTemplate name.
VersaDirector.DataStoreTemplate.appliance-ownerstringDataStore template appliance owner.
VersaDirector.DataStoreTemplate.available-routing-instancesstringDataStore template available routing instances.
VersaDirector.DataStoreTemplate.owned-routing-instancesstringDataStore template owned routing instances.
VersaDirector.DataStoreTemplate.available-networksstringDataStore template available networks.

Command example#

!vd-datastore-template-list limit=3

Context Example#

{
"VersaDirector": {
"DataStoreTemplate": {
"collection": {
"org": {
"appliance-owner": null,
"available-networks": [
"INET",
"INET-2",
"LTE",
"MPLS",
"MPLS-2"
],
"available-routing-instances": "EXAMPLE_CLIENT-LAN-VR",
"name": "EXAMPLE_CLIENT",
"owned-routing-instances": "EXAMPLE_CLIENT-LAN-VR"
}
}
}
}
}

Human Readable Output#

Templates associated with EXAMPLE_CLIENT Data-Store#

NameAvailable - Routing - InstancesOwned - Routing - InstancesAvailable - Networks
EXAMPLE_CLIENTEXAMPLE_CLIENT-LAN-VREXAMPLE_CLIENT-LAN-VRINET,
INET-2,
LTE,
MPLS,
MPLS-2

vd-template-list#


List all templates associated with a specific organization. Default type argument is 'MAIN'.

Base Command#

vd-template-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
typeType of template. If not specified in the request, all types will be fetched. Possible values are: SERVICE, MAIN.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.TemplateTemplate name.

Command example#

!vd-template-list limit=3

Context Example#

{
"VersaDirector": {
"Template": [
{
"analyticsEnabled": true,
"compositeOrPrimary": "composite",
"dynamicTenantConfig": false,
"isAnalyticsEnabled": true,
"isDynamicTenantConfig": false,
"isPrimary": true,
"isStaging": false,
"lockDetails": {
"lockType": "NONE",
"user": "EXAMPLE_USER"
},
"name": "EXAMPLE_SITE",
"organization": [
"EXAMPLE_CLIENT"
],
"primary": true,
"providerTenant": "EXAMPLE_CLIENT",
"rbacResourceTags": [],
"staging": false,
"templateType": "sdwan-post-staging"
}
]
}
}

Human Readable Output#

Templates associated with EXAMPLE_CLIENT#

NameOrganizationLock DetailsTemplate TypeIs PrimaryIs Staging
EXAMPLE_SITEEXAMPLE_CLIENTuser: EXAMPLE_USER
lockType: NONE
sdwan-post-stagingtruefalse

vd-appliance-group-template-appliance-list#


List all appliances associated with a specific device-group and associated templates

Base Command#

vd-appliance-group-template-appliance-list

Input#

Argument NameDescriptionRequired
device_groupDevice group name.Required
template_nameTemplate name.Required
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.DeviceGroup.createDatestringDate the device group was created.
VersaDirector.DeviceGroup.modifyDatestringDate the device group was modified.
VersaDirector.DeviceGroup.lastUpdatedBystringBy whom the device group was last updated.
VersaDirector.DeviceGroup.namestringDevice group name.
VersaDirector.DeviceGroup.poststagingTemplatePrioritystringDevice group post staging template priority.
VersaDirector.DeviceGroup.oneTimePasswordstringDevice group one time password.
VersaDirector.DeviceGroup.poststaging-templatestringDevice group post staging template.
VersaDirector.DeviceGroup.enable-2factor-authstringDevice group enable two factor authentication.
VersaDirector.DeviceGroup.enable-staging-urlstringDevice group enable staging URL.

Command example#

!vd-appliance-group-template-appliance-list device_group="EXAMPLE_BRANCH" template_name=EXAMPLE_CLIENT-Test-NGFW limit=3

Context Example#

{
"VersaDirector": {
"DeviceGroup": {
"ca-config-on-branch-notification": false,
"enable-2factor-auth": false,
"enable-staging-url": false,
"inventory-name": [],
"name": "EXAMPLE_BRANCH",
"oneTimePassword": false,
"poststaging-template": "EXAMPLE_CLIENT-Test-NGFW",
"template-association": [
{
"category": "DataStore",
"deviceTemplateStatus": null,
"name": "EXAMPLE_CLIENT-DataStore",
"organization": "EXAMPLE_CLIENT",
"templateAssociationType": "DEVICE_GROUP"
},
{
"category": "Main",
"deviceTemplateStatus": null,
"name": "EXAMPLE_CLIENT-Test-NGFW",
"organization": "EXAMPLE_CLIENT",
"templateAssociationType": "DEVICE_GROUP"
}
]
}
}
}

Human Readable Output#

Appliances#

NamePoststaging - TemplateTemplate - Association
EXAMPLE_BRANCHEXAMPLE_CLIENT-Test-NGFW- name: EXAMPLE_CLIENT-DataStore
- name: EXAMPLE_CLIENT-Test-NGFW

vd-appliance-group-list#


List all appliance (device) groups associated with an organization (tenant)

Base Command#

vd-appliance-group-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.DeviceGroup.createDatestringDate the device group was created.
VersaDirector.DeviceGroup.modifyDatestringDate the device group was modified.
VersaDirector.DeviceGroup.lastUpdatedBystringBy whom the device group was last updated.
VersaDirector.DeviceGroup.namestringDevice group name.
VersaDirector.DeviceGroup.organizationstringAssociated organization.
VersaDirector.DeviceGroup.poststagingTemplatePrioritynumberPost staging template priority.
VersaDirector.DeviceGroup.oneTimePasswordstringOne time password.
VersaDirector.DeviceGroup.poststaging-templatestringPost staging template.
VersaDirector.DeviceGroup.enable-2factor-authstringEnable two factor authentication.
VersaDirector.DeviceGroup.enable-staging-urlstringEnable staging URL.
VersaDirector.DeviceGroup.inventory-nameStringInventory name.

Command example#

!vd-appliance-group-list limit=3

Context Example#

{
"VersaDirector": {
"DeviceGroup": {
"device-group": [
{
"ca-config-on-branch-notification": false,
"createDate": "2022-10-05 10:44:26",
"enable-2factor-auth": false,
"enable-staging-url": false,
"inventory-name": [
"EXAMPLE_BRANCH"
],
"lastUpdatedBy": "EXAMPLE_USER",
"modifyDate": "2022-10-05 10:44:26",
"name": "EXAMPLE_BRANCH-DG",
"oneTimePassword": false,
"organization": "EXAMPLE_CLIENT",
"poststaging-template": "EXAMPLE_SITE",
"poststagingTemplatePriority": 2
}
],
"totalCount": 1
}
}
}

Human Readable Output#

Appliance groups associated with EXAMPLE_CLIENT#

NameOrganizationCreate DateInventory - NamePoststaging - Template
EXAMPLE_BRANCH-DGEXAMPLE_CLIENT2022-10-05 10:44:26EXAMPLE_BRANCHEXAMPLE_SITE

vd-organization-appliance-list#


List all devices associated with a specific organization.

Base Command#

vd-organization-appliance-list

Input#

Argument NameDescriptionRequired
organizationName of the associated organization.Optional
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page. default value 0.Optional
limitThe maximum number of results to retrieve. Default is 50.Optional

Context Output#

PathTypeDescription
VersaDirector.Appliance.namestringAppliance name.
VersaDirector.Appliance.uuidstringAppliance UUID.
VersaDirector.Appliance.applianceLocationstringAppliance location.

Command example#

!vd-organization-appliance-list limit=3

Context Example#

{
"VersaDirector": {
"Appliance": {
"appliances": [
{
"Hardware": {
"cpuCores": 0,
"cpuCount": 4,
"cpuLoad": 2,
"cpuModel": "X",
"diskSize": "X",
"fanless": false,
"firmwareVersion": "X",
"freeDisk": "70.78GiB",
"freeMemory": "4.11GiB",
"hardWareSerialNo": "Not Specified",
"intelQuickAssistAcceleration": false,
"interfaceCount": 6,
"lpm": false,
"manufacturer": "X",
"memory": "X",
"model": "X",
"name": "EXAMPLE_BRANCH",
"packageName": "EXAMPLE_PACKAGE",
"serialNo": "EXAMPLE_BRANCH-SN",
"sku": "Not Specified",
"ssd": false
},
"OssPack": {
"name": "EXAMPLE_BRANCH",
"osspackVersion": "unknown",
"updateType": "unknown"
},
"SPack": {
"apiVersion": "Version",
"flavor": "SAMPLE",
"name": "EXAMPLE_BRANCH",
"releaseDate": "X",
"spackVersion": "X",
"updateType": "full"
},
"alarmSummary": {
"columnNames": [
"columnName 0"
],
"monitorType": "Alarms",
"rows": [
{
"columnValues": [
0
],
"firstColumnValue": "critical"
},
{
"columnValues": [
3
],
"firstColumnValue": "major"
},
{
"columnValues": [
0
],
"firstColumnValue": "minor"
},
{
"columnValues": [
0
],
"firstColumnValue": "warning"
},
{
"columnValues": [
0
],
"firstColumnValue": "indeterminate"
},
{
"columnValues": [
12
],
"firstColumnValue": "cleared"
}
],
"tableId": "Alarms",
"tableName": "Alarms"
},
"appIdDetails": {
"appIdAvailableBundleVersion": "EXAMPLE_VERSION ",
"appIdInstalledBundleVersion": "EXAMPLE_VERSION ",
"appIdInstalledEngineVersion": "EXAMPLE_VERSION "
},
"applianceCapabilities": {
"capabilities": [
"path-state-monitor",
"bw-in-interface-state",
"config-encryption:v3",
"route-filter-feature"
]
},
"applianceLocation": {
"applianceName": "EXAMPLE_BRANCH",
"applianceUuid": "X",
"latitude": "0.",
"locationId": "X",
"longitude": "0.",
"type": "EXAMPLE"
},
"branch-maintenance-mode": false,
"branchId": "ID",
"branchInMaintenanceMode": false,
"connector": "local",
"connectorType": "local",
"controll-status": "Unavailable",
"controllers": [
"Controller-1"
],
"cpeHealth": {
"columnNames": [
"Category",
"Up",
"Down",
"Disabled"
],
"rows": [
{
"columnValues": [
0,
0,
0
],
"firstColumnValue": "Physical Ports"
},
{
"columnValues": [
1,
0,
0
],
"firstColumnValue": "Config Sync Status"
},
{
"columnValues": [
1,
0,
0
],
"firstColumnValue": "Reachability Status"
},
{
"columnValues": [
1,
0,
0
],
"firstColumnValue": "Service Status"
}
]
},
"createdAt": "X",
"deployment": "normal",
"inter-chassis-ha-status": {
"ha-configured": false
},
"intra-chassis-ha-status": {
"ha-configured": false
},
"ipAddress": "EXAMPLE_URL",
"last-updated-time": "2022-11-13 10:24:39.0",
"location": "LOCATION",
"lockDetails": {
"lockType": "NONE",
"user": "EXAMPLE_USER"
},
"name": "EXAMPLE_BRANCH",
"nodes": {
"nodeStatusList": {
"cpu-load": 2,
"host-ip": "NOT-APPLICABLE",
"load-factor": 2,
"memory-load": 9,
"node-type": "VCSN",
"slot-id": 0,
"vm-name": "NOT-APPLICABLE",
"vm-status": "NOT-APPLICABLE"
}
},
"overall-status": "NOT-APPLICABLE",
"ownerOrg": "EXAMPLE_CLIENT",
"path-status": "Unavailable",
"ping-status": "REACHABLE",
"refreshCycleCount": 0,
"services": [
"sdwan",
"nextgen-firewall",
"cgnat"
],
"services-status": "GOOD",
"sngCount": 0,
"softwareVersion": "",
"startTime": "Mon Nov 7 05:11:42 2022",
"sync-status": "IN_SYNC",
"type": "branch",
"ucpe-nodes": {
"ucpeNodeStatusList": []
},
"unreachable": false,
"uuid": "X",
"yang-compatibility-status": "Unavailable"
}
],
"totalCount": 1
}
}
}

Human Readable Output#

Organization List#

NameIp AddressTypeSoftware VersionOwner Org
EXAMPLE_BRANCHEXAMPLE_URLbranchNORMALEXAMPLE_CLIENT

vd-organization-list#


List all organizations/tenants.

Base Command#

vd-organization-list

Input#

Argument NameDescriptionRequired
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results to retrieve.Optional

Context Output#

PathTypeDescription
VersaDirector.Organization.nameStringOrganization name.
VersaDirector.Organization.uuidStringOrganization UUID.
VersaDirector.Organization.parentStringOrganization parent.
VersaDirector.Organization.subscriptionPlanStringOrganization subscription plan.
VersaDirector.Organization.idStringOrganization ID.
VersaDirector.Organization.authTypeStringOrganization auth type.
VersaDirector.Organization.cpeDeploymentTypeStringOrganization CPE deployment type.
VersaDirector.Organization.appliancesStringOrganization appliances.
VersaDirector.Organization.vrfsGroupsStringOrganization VRFS groups.
VersaDirector.Organization.wanNetworkGroupsStringOrganization WAN network groups.
VersaDirector.Organization.analyticsClustersStringOrganization analytics clusters.
VersaDirector.Organization.sharedControlPlaneStringOrganization shared control plane.
VersaDirector.Organization.blockInterRegionRoutingStringOrganization blockInter region routing.

Command example#

!vd-organization-list limit=3

Context Example#

{
"VersaDirector": {
"Organization": [
{
"analyticsClusters": [
"Analytics-Cluster"
],
"appliances": [
"X",
"Y"
],
"authType": "psk",
"blockInterRegionRouting": false,
"cpeDeploymentType": "SDWAN",
"dynamicTenantConfig": {
"inactivityInterval": 48,
"uuid": "X"
},
"id": 1,
"name": "EXAMPLE_CLIENT",
"parent": "Versa",
"sharedControlPlane": false,
"subscriptionPlan": "EXAMPLE_PLAN",
"uuid": "X",
"vrfsGroups": [
{
"description": null,
"enable_vpn": true,
"id": 2,
"name": "EXAMPLE_CLIENT-LAN-VR",
"vrfId": 152
}
],
"wanNetworkGroups": [
{
"description": "",
"id": 3,
"name": "INET",
"transport-domains": [
"Internet"
]
},
{
"description": "",
"id": 4,
"name": "INET-2",
"transport-domains": [
"Internet"
]
},
{
"description": "",
"id": 5,
"name": "LTE",
"transport-domains": [
"Internet"
]
},
{
"description": "",
"id": 6,
"name": "MPLS",
"transport-domains": [
"MPLS"
]
},
{
"description": "",
"id": 7,
"name": "MPLS-2",
"transport-domains": [
"MPLS-2"
]
}
]
}
]
}
}

Human Readable Output#

Organization List#

NameIdParentAppliancesCpe Deployment TypeUuid
EXAMPLE_CLIENTIDVersaNAMESDWANXXX

vd-appliance-list#


List all available appliances for all organizations/tenants, with a limit of max 25 appliances per organization.

Base Command#

vd-appliance-list

Input#

Argument NameDescriptionRequired
pageThe page number of the results to retrieve.Optional
page_sizeThe maximum number of objects to retrieve per page.Optional
limitThe maximum number of results.Optional

Context Output#

PathTypeDescription
VersaDirector.Appliance.nameStringAppliance name.
VersaDirector.Appliance.uuidStringAppliance UUID.
VersaDirector.Appliance.ipAddressStringAppliance IP address.
VersaDirector.Appliance.appTypeStringAppliance application type.
VersaDirector.Appliance.branchIdNumberApplication branch ID.

Command example#

!vd-appliance-list limit=3

Context Example#

{
"VersaDirector": {
"Appliance": {
"appliance-list": [
{
"appType": "branch",
"branchId": "ID",
"ipAddress": "EXAMPLE_URL",
"name": "EXAMPLE_BRANCH",
"uuid": "X"
}
]
}
}
}

Human Readable Output#

Appliances#

NameUuidIp AddressApp TypeBranch Id
EXAMPLE_BRANCHUUIDEXAMPLE_URLbranchID