name: VersaDirector display: Versa Director description: 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. category: Network Security provider: Versa Networks sectionorder: - Connect - Collect commonfields: id: VersaDirector version: -1 configuration: - defaultvalue: https://demo.example.com display: Your server URL name: url required: true type: 0 section: Connect - display: Organization Name name: organization additionalinfo: Used by any command that requires an organization argument. Should be passed as a parameter in the configuration or as a command argument. type: 0 required: false section: Connect - display: Username name: credentials type: 9 required: false section: Connect - display: Use Basic Authentication additionalinfo: Check this checkbox to use the basic authentication method. Auth Token authentication will be used by default. To use basic authentication method, enter values for the Username and Password parameters. name: use_basic_auth type: 8 required: false section: Connect - display: Client ID additionalinfo: The Client ID parameter is used for Auth authentication. Used together with the Client Secret parameter. name: client_id type: 0 hidden: true required: false section: Connect - display: Client Secret additionalinfo: The Client Secret parameter is used for Auth authentication. Used together with the Client ID parameter. name: client_secret type: 4 hidden: true required: false section: Connect - display: Client ID name: credentials_client required: false type: 9 displaypassword: Client Secret section: Connect - display: Auth Token additionalinfo: The Auth Token parameter is used for Auth authentication.\nBy default, an Auth Token passed as a parameter takes priority over an Auth Token saved in the integration context.\nIf 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. name: access_token type: 4 hidden: true required: false section: Connect - displaypassword: Auth Token additionalinfo: The Auth Token parameter is used for Auth authentication.\nBy default, an Auth Token passed as a parameter takes priority over an Auth Token saved in the integration context.\nIf 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. name: credentials_access_token required: false hiddenusername: true type: 9 section: Connect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect script: script: '' commands: - name: vd-predefined-application-list description: List all user predefined application objects. arguments: - name: family description: Group type of the application. auto: PREDEFINED predefined: - business-system - collaboration - general-internet - media - networking - name: risks description: Risks threshold. This value must be equal to or higher than the input. - name: tags description: A comma-separated list of tags. isArray: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. Default is 0. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.PredefinedApplication.name description: Predefined application's name. type: string - contextPath: VersaDirector.PredefinedApplication.family description: Predefined application family type. type: string - contextPath: VersaDirector.PredefinedApplication.subfamily description: Predefined sub-group family application type. type: string - contextPath: VersaDirector.PredefinedApplication.description description: Predefined application description. type: string - contextPath: VersaDirector.PredefinedApplication.risk description: Predefined application risks threshold. This value is equal to or higher than the input. type: string - contextPath: VersaDirector.PredefinedApplication.productivity description: Predefined application productivity. type: string - contextPath: VersaDirector.PredefinedApplication.tag description: Predefined application tag. type: string - name: vd-appliance-user-modified-application-list description: List all user modified predefined application objects associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-name description: Appliance user modified application name. type: string - contextPath: VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-risk description: Appliance user modified application risk threshold. type: string - contextPath: VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-productivity description: Appliance user modified application productivity. type: string - contextPath: VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-timeout description: Appliance user modified application timeout. type: string - contextPath: VersaDirector.ApplianceUserModifiedApplication.app-specific-option-list.app-final-with-endpoint description: Appliance user modified application final endpoint. type: string - name: vd-template-user-modified-application-list description: List all user modified predefined application objects associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-name description: Template user modified application name. type: string - contextPath: VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-risk description: Template user modified application risk threshold. type: string - contextPath: VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-productivity description: Template user modified application productivity. type: string - contextPath: VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-timeout description: Template user modified application timeout. type: string - contextPath: VersaDirector.TemplateUserModifiedApplication.app-specific-option-list.app-final-with-endpoint description: Template user modified application final endpoint. type: string - name: vd-appliance-user-defined-application-list description: List all user defined application objects associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.app-name description: Appliance user defined application name. type: string - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.description description: Appliance user defined application description. type: string - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.precedence description: Appliance user defined application precedence. type: string - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.tag description: Appliance user defined application tag. type: string - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.risk description: Appliance user defined application risk threshold. type: string - contextPath: VersaDirector.ApplianceUserDefinedApplication.user-defined-application.family description: Appliance user defined application family. type: string - name: vd-template-user-defined-application-list description: List all user defined application objects associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.app-name description: Template user defined application name. type: string - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.description description: Template user defined application description. type: string - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.precedence description: Template user defined application precedence. type: string - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.tag description: Template user defined application tag. type: string - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.risk description: Template user defined application risk threshold. type: string - contextPath: VersaDirector.TemplateUserDefinedApplication.user-defined-application.family description: Template user defined application family. type: string - name: vd-appliance-address-object-delete description: Delete an address object associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: object_name description: Address object name. required: true - name: vd-appliance-address-object-edit description: Edit an address object associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: object_name description: Address object name. required: true - name: description description: Address object description. - name: tags description: A comma-separated list of tags. isArray: true - name: address_object_type description: Address object type. required: true auto: PREDEFINED predefined: - ipv4-prefix - ipv4-range - ipv4-wildcard-mask - ipv6-prefix - fqdn - dynamic-address - name: object_value description: Object value. required: true outputs: - contextPath: VersaDirector.TemplateAddressObject.name description: Template address object name. type: string - contextPath: VersaDirector.TemplateAddressObject.tag description: Template Address object tag. type: string - contextPath: VersaDirector.TemplateAddressObject.description description: Template address object description. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-prefix description: Template address object IPv4 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-range description: Template address object IPv4 range. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-wildcard-mask description: Template address object IPv4 wildcard mask. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv6-prefix description: Template address object IPv6 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.fqdn description: Template address object FQDN. type: string - contextPath: VersaDirector.TemplateAddressObject.dynamic-address description: Template address object dynamic address. type: string - name: vd-appliance-address-object-create description: Create an address object associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: object_name description: Address object name. required: true - name: description description: Address object description. required: true - name: tags description: A comma-separated list of tags. isArray: true - name: address_object_type description: Address object type. required: true auto: PREDEFINED predefined: - ipv4-prefix - ipv4-range - ipv4-wildcard-mask - ipv6-prefix - fqdn - dynamic-address - name: object_value description: Object value. required: true outputs: - contextPath: VersaDirector.TemplateAddressObject.name description: Template address object name. type: string - contextPath: VersaDirector.TemplateAddressObject.tag description: Template address object tag. type: string - contextPath: VersaDirector.TemplateAddressObject.description description: Template address object description. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-prefix description: Template address object IPv4 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-range description: Template address object IPv4 range. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-wildcard-mask description: Template address object IPv4 wildcard mask. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv6-prefix description: Template address object IPv6 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.fqdn description: Template address object FQDN. type: string - contextPath: VersaDirector.TemplateAddressObject.dynamic-address description: Template address object dynamic address. type: string - name: vd-appliance-address-object-list description: List all address objects associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplianceAddressObject.name description: Appliance address object name. type: string - contextPath: VersaDirector.ApplianceAddressObject.description description: Appliance address object description. type: string - contextPath: VersaDirector.ApplianceAddressObject.tag description: Appliance address object tag. type: string - contextPath: VersaDirector.ApplianceAddressObject.ipv4-prefix description: Appliance address object ipv4-prefix. type: string - contextPath: VersaDirector.ApplianceAddressObject.fqdn description: Appliance address object fqdn. type: string - name: vd-template-address-object-delete description: Delete an address object associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: object_name description: Address object name. required: true - name: vd-template-address-object-edit description: Create an address object associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: object_name description: Address object name. required: true - name: description description: Address object description. - name: tags description: A comma-separated list of tags. - name: address_object_type description: Address object type. required: true auto: PREDEFINED predefined: - ipv4-prefix - ipv4-range - ipv4-wildcard-mask - ipv6-prefix - fqdn - dynamic-address - name: object_value description: Object value. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.TemplateAddressObject.name description: Template address object name. type: string - contextPath: VersaDirector.TemplateAddressObject.tag description: Template address object tag. type: string - contextPath: VersaDirector.TemplateAddressObject.description description: Template address object description. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-prefix description: Template address object IPv4 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-range description: Template address object IPv4 range. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-wildcard-mask description: Template address object IPv4 wildcard mask. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv6-prefix description: Template address object IPv6 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.fqdn description: Template address object FQDN. type: string - contextPath: VersaDirector.TemplateAddressObject.dynamic-address description: Template address object dynamic address. type: string - name: vd-template-address-object-create description: Create an address object associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: object_name description: Address object name. required: true - name: description description: Address object description. - name: tags description: A comma-separated list of tags. - name: address_object_type description: Address object type. required: true auto: PREDEFINED predefined: - ipv4-prefix - ipv4-range - ipv4-wildcard-mask - ipv6-prefix - fqdn - dynamic-address - name: object_value description: Object value. required: true outputs: - contextPath: VersaDirector.TemplateAddressObject.name description: Template address object name. type: string - contextPath: VersaDirector.TemplateAddressObject.tag description: Template address object tag. type: string - contextPath: VersaDirector.TemplateAddressObject.description description: Template address object description. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-prefix description: Template address object IPv4 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-range description: Template address object IPv4 range. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-wildcard-mask description: Template address object IPv4 wildcard mask. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv6-prefix description: Template address object IPv6 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.fqdn description: Template address object FQDN. type: string - contextPath: VersaDirector.TemplateAddressObject.dynamic-address description: Template address object dynamic address. type: string - name: vd-template-address-object-list description: List all address objects associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.TemplateAddressObject.name description: Template address object name. type: string - contextPath: VersaDirector.TemplateAddressObject.description description: Template address object description. type: string - contextPath: VersaDirector.TemplateAddressObject.tag description: Template address object tag. type: string - contextPath: VersaDirector.TemplateAddressObject.ipv4-prefix description: Template address object IPv4 prefix. type: string - contextPath: VersaDirector.TemplateAddressObject.fqdn description: Template address object FQDN. type: string - name: vd-appliance-sdwan-policy-rule-delete description: Delete an SDWAN policy rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: rule_name description: Name of the rule. required: true - name: vd-appliance-sdwan-policy-rule-edit description: Edit an SDWAN policy rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: URL reputation. - name: custom_url_categories description: A comma-separated list of custom URL categories. isArray: true - name: forwarding_action description: Forwarding action. required: true auto: PREDEFINED predefined: - allow - deny - name: nexthop_ip description: Nexthop IP. - name: routing_instance description: Routing instance. - name: forwarding_profile description: Forwarding profile. - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-appliance-sdwan-policy-rule-create description: Create an SDWAN policy rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: URL reputation. - name: custom_url_categories description: A comma-separated list of custom URL categories. isArray: true - name: forwarding_action description: Forwarding action. required: true auto: PREDEFINED predefined: - allow - deny - name: nexthop_ip description: Nexthop IP. - name: routing_instance description: Routing instance. - name: forwarding_profile description: Forwarding profile. - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-appliance-sdwan-policy-rule-list description: List all SDWAN policy rules associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of objects to return. outputs: - contextPath: VersaDirector.ApplianceSdwanPolicyRule.name description: Policy rule name. type: string - contextPath: VersaDirector.ApplianceSdwanPolicyRule.description description: Policy rule description. type: string - contextPath: VersaDirector.ApplianceSdwanPolicyRule.rule-disable description: Rule is disabled. type: string - contextPath: VersaDirector.ApplianceSdwanPolicyRule.set.action description: Rule action. type: string - name: vd-appliance-sdwan-policy-list description: List all SDWAN policies associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplianceSdwanPolicy.address description: Appliance SDWAN policy address. type: string - contextPath: VersaDirector.ApplianceSdwanPolicy.rule-disable description: Appliance SDWAN policy rule disabled. type: string - contextPath: VersaDirector.ApplianceSdwanPolicy.match description: Appliance SDWAN policy set Matching objects. type: string - contextPath: VersaDirector.ApplianceSdwanPolicy.set description: Appliance SDWAN policy set. type: string - name: vd-template-sdwan-policy-rule-delete description: Delete an SDWAN policy rule associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: rule_name description: Name of the rule. required: true - name: vd-template-sdwan-policy-rule-edit description: Edit an SDWAN policy rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: custom_url_categories description: A comma-separated list of custom URL categories. isArray: true - name: forwarding_action description: Forwarding action. required: true auto: PREDEFINED predefined: - allow - deny - name: nexthop_ip description: Nexthop IP. - name: routing_instance description: Routing instance. - name: forwarding_profile description: Forwarding profile. - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-template-sdwan-policy-rule-create description: Create an SDWAN policy rule associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: custom_url_categories description: A comma-separated list of custom URL categories. isArray: true - name: forwarding_action description: Forwarding action. required: true auto: PREDEFINED predefined: - allow - deny - name: nexthop_ip description: Nexthop IP. - name: routing_instance description: Routing instance. - name: forwarding_profile description: Forwarding profile. - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-template-sdwan-policy-rule-list description: List all SDWAN policy rules associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: sdwan_policy_name description: Name of the SDWAN policy. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.name description: Template SDWAN policy group name. type: string - contextPath: VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.rules description: Template SDWAN policy group rules. type: string - name: vd-template-sdwan-policy-list description: List all SDWAN policies associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.name description: Template SDWAN policy group name. type: string - contextPath: VersaDirector.TemplateSdwanPolicy.sdwan-policy-group.rules description: Template SDWAN policy group rules. type: string - name: vd-appliance-access-policy-rule-delete description: Delete an access policy configuration (NGFW) rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: access_policy_name description: Access policy name. required: true - name: rule_name description: Name of the rule. required: true - name: vd-appliance-access-policy-rule-edit description: Edit an access policy configuration (NGFW) rule associated with a specific appliance (device). Important note - the data provided in the request overwrites the existing rule settings. arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: access_policy_name description: Access policy name. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-appliance-access-policy-rule-create description: Create an access policy configuration (NGFW) rule associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: access_policy_name description: Access policy name. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. required: true - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. required: true isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. required: true isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-appliance-access-policy-rule-list description: List all access policy configuration (NGFW) rules associated with a specific appliance. arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: access_policy_name description: Access policy name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplianceAccessPolicyRule.name description: Appliance access policy rule name. type: string - contextPath: VersaDirector.ApplianceAccessPolicyRule.description description: Appliance access policy rule description. type: string - contextPath: VersaDirector.ApplianceAccessPolicyRule.tag description: Appliance access policy rule tag. type: string - contextPath: VersaDirector.ApplianceAccessPolicyRule.rule-disable description: Appliance access policy rule disabled. type: string - name: vd-appliance-access-policy-list description: List all access policies associated with a specific organization and appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplianceAccessPolicy.name description: Access policy name. type: string - contextPath: VersaDirector.ApplianceAccessPolicy.rules description: Access policy rules. type: string - name: vd-template-access-policy-rule-delete description: Delete an access policy configuration (NGFW) rule associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: access_policy_name description: Access policy name. required: true - name: rule_name description: Name of the rule. required: true - name: vd-template-access-policy-rule-edit description: Edit an access policy configuration (NGFW) rule associated with a specific template. Important note - the data provided in the request overwrites the existing rule settings. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: access_policy_name description: Access policy name. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: SDWAN policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-template-access-policy-rule-create description: Create an access policy configuration (NGFW) rule associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: access_policy_name description: Access policy name. required: true - name: custom_rule_json description: Allows 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. - name: rule_name description: Name of the rule. required: true - name: description description: Access policy description. - name: tags description: A comma-separated list of tags. isArray: true - name: source_address_objects description: A comma-separated list of source address objects. isArray: true - name: destination_address_objects description: A comma-separated list of destination address objects. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: predefined_application description: A comma-separated list of predefined applications. isArray: true - name: user_defined_application description: A comma-separated list of user defined applications. isArray: true - name: vd-template-access-policy-rule-list description: List all access policy configuration (NGFW) rules associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: access_policy_name description: Access policy name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.TemplateAccessPolicy.name description: Template access policy name. type: string - contextPath: VersaDirector.TemplateAccessPolicy.description description: Template access policy description. type: string - contextPath: VersaDirector.TemplateAccessPolicy.tag description: Template access policy tag. type: string - contextPath: VersaDirector.TemplateAccessPolicy.rule-disable description: Template access policy disabled. type: string - name: vd-template-access-policy-list description: List all access policies associated with a specific organization and template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.TemplateAccessPolicy.name description: Template access policy name. type: string - contextPath: VersaDirector.TemplateAccessPolicy.rules description: Access policy rules. type: string - name: vd-appliance-custom-url-category-delete description: Delete a custom URL category associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: url_category_name description: URL category name. required: true outputs: - contextPath: VersaDirector.ApplianceCustomUrlCategory.category-name description: Appliance custom URL category category name. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.category-description description: Appliance custom URL category description. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.confidence description: Appliance custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.urls description: Appliance custom URL category URLs. type: string - name: vd-appliance-custom-url-category-edit description: Edit a custom URL category associated with a specific appliance (device). Important note - the data provided in the request overwrites the existing object. arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: url_category_name description: URL category name. required: true - name: description description: Custom URL category description. required: true - name: confidence description: Confidence threshold. required: true - name: urls description: A comma-separated list of URLs. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: patterns description: A comma-separated list of patterns. isArray: true - name: pattern_reputation description: A comma-separated list of pattern reputations. isArray: true outputs: - contextPath: VersaDirector.ApplianceCustomUrlCategory.category-name description: Appliance custom URL category category name. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.category-description description: Appliance custom URL category description. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.confidence description: Appliance custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.urls description: Appliance custom URL category URLs. type: string - name: vd-appliance-custom-url-category-create description: Create a custom URL category associated with a specific appliance (device). arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: url_category_name description: URL category name. required: true - name: description description: Custom URL category description. required: true - name: confidence description: Confidence threshold. required: true - name: urls description: A comma-separated list of URLs. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: patterns description: A comma-separated list of patterns. isArray: true - name: pattern_reputation description: A comma-separated list of pattern reputations. isArray: true outputs: - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.category-name description: Appliance custom URL category name. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.category-description description: Appliance custom URL category description. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.confidence description: Appliance custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.urls description: Appliance custom URL category URLs. type: string - name: vd-appliance-custom-url-category-list description: List all custom URL categories associated with a specific appliance or get a specific custom URL category. arguments: - name: organization description: Name of the associated organization. - name: appliance_name description: Appliance name. required: true - name: url_category_name description: URL category name. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplianceCustomUrlCategory.category-name description: Appliance custom URL category name. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.category-description description: Appliance custom URL category description. type: string - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.confidence description: Appliance custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplianceCustomUrlCategory.content.urls description: Appliance custom URL category URLs. type: string - name: vd-template-custom-url-category-delete description: Delete a custom URL category associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: url_category_name description: URL category name. required: true outputs: - contextPath: VersaDirector.TemplateCustomUrlCategory.category-name description: Template custom URL category name. type: string - contextPath: VersaDirector.TemplateCustomUrlCategory.category-description description: Template custom URL category description. type: string - contextPath: VersaDirector.TemplateCustomUrlCategory.content.confidence description: Template custom URL category confidence threshold. type: number - contextPath: VersaDirector.TemplateCustomUrlCategory.content.urls description: Template custom URL category URLs. type: string - name: vd-template-custom-url-category-edit description: Edit a custom URL category associated with a specific template. Important note - the data provided in the request overwrites the existing object. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: url_category_name description: URL category name. required: true - name: description description: Custom URL category description. required: true - name: confidence description: Confidence threshold. required: true - name: urls description: A comma-separated list of URLs. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: patterns description: A comma-separated list of patterns. isArray: true - name: pattern_reputation description: A comma-separated list of pattern reputations. isArray: true outputs: - contextPath: VersaDirector.TemplateCustomUrlCategory.category-name description: Template custom URL category name. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.category-description description: Template custom URL category description. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.confidence description: Template custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplicationServiceTemplate.content.urls description: Template custom URL category URLs. type: string - name: vd-template-custom-url-category-create description: Create a custom URL category associated with a specific template. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: url_category_name description: URL category name. required: true - name: description description: Custom URL category description. required: true - name: confidence description: Confidence threshold. required: true - name: urls description: A comma-separated list of URLs. isArray: true - name: url_reputation description: A comma-separated list of URL reputations. isArray: true - name: patterns description: A comma-separated list of patterns. isArray: true - name: pattern_reputation description: A comma-separated list of pattern reputations. isArray: true outputs: - contextPath: VersaDirector.TemplateCustomUrlCategory.category-name description: Template custom URL category name. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.category-description description: Template custom URL category category description. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.confidence description: Template custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplicationServiceTemplate.content.urls description: Template custom URL category URLs. type: string - name: vd-template-custom-url-category-list description: List all custom URL categories associated with a specific template or get a specific custom URL category. arguments: - name: organization description: Name of the associated organization. - name: template_name description: Template name. required: true - name: url_category_name description: URL category name. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.TemplateCustomUrlCategory.category-name description: Template custom URL category name. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.category-description description: Template custom URL category category description. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.confidence description: Template custom URL category confidence threshold. type: number - contextPath: VersaDirector.ApplicationServiceTemplate.content.urls description: Template custom URL category URLs. type: string - name: vd-template-change-commit description: 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. polling: true execution: true arguments: - name: template_name description: New template name for the device. required: true - name: appliances description: A comma-separated list of devices the change will be committed to. required: true isArray: true - name: mode description: Commit mode to specified devices. auto: PREDEFINED required: true predefined: - overwrite - merge - forced_merge - name: task_id description: Task ID hidden polling command. deprecated: true - name: hide_polling_output description: Whether to hide the polling result (automatically filled by polling). deprecated: true - name: reboot description: Reboot devices after change is committed (true/false). required: true outputs: - contextPath: VersaDirector.Commit.versa-tasks.id description: Task ID. type: string - contextPath: VersaDirector.Commit.versa-tasks.task-description description: Task description. type: string - contextPath: VersaDirector.Commit.versa-tasks.user description: Task user. type: string - contextPath: VersaDirector.Commit.task-status description: Task status. type: string - contextPath: VersaDirector.Commit.versa-tasks.progressmessage description: Task progress message. type: string - name: vd-application-service-template-list description: List all application service templates. Can be filtered by organization or a keyword search. arguments: - name: organization description: Name of the associated organization. - name: keyword description: Keyword by which to search. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.ApplicationServiceTemplate.createDate description: Date the application service template was created. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.modifyDate description: Date the application service template was modified. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.lastUpdatedBy description: By whom the application service template was last updated. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.name description: Application service template content name. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.organization description: Application service template associated organization. type: string - contextPath: VersaDirector.ApplicationServiceTemplate.content.status description: Application service template status. type: string - name: vd-datastore-template-list description: 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. arguments: - name: organization description: Name of the associated organization. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.DataStoreTemplate.name description: Template name. type: string - contextPath: VersaDirector.DataStoreTemplate.appliance-owner description: DataStore template appliance owner. type: string - contextPath: VersaDirector.DataStoreTemplate.available-routing-instances description: DataStore template available routing instances. type: string - contextPath: VersaDirector.DataStoreTemplate.owned-routing-instances description: DataStore template owned routing instances. type: string - contextPath: VersaDirector.DataStoreTemplate.available-networks description: DataStore template available networks. type: string - name: vd-template-list description: List all templates associated with a specific organization. Default type argument is 'MAIN'. arguments: - name: organization description: Name of the associated organization. - name: type auto: PREDEFINED description: Type of template. If not specified in the request, all types will be fetched. predefined: - SERVICE - MAIN - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.Template description: Template name. type: '' - name: vd-appliance-group-template-appliance-list description: List all appliances associated with a specific device-group and associated templates. arguments: - name: device_group description: Device group name. required: true - name: template_name description: Template name. required: true - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.DeviceGroup.createDate description: Date the device group was created. type: string - contextPath: VersaDirector.DeviceGroup.modifyDate description: Date the device group was modified. type: string - contextPath: VersaDirector.DeviceGroup.lastUpdatedBy description: By whom the device group was last updated. type: string - contextPath: VersaDirector.DeviceGroup.name description: Device group name. type: string - contextPath: VersaDirector.DeviceGroup.poststagingTemplatePriority description: Device group post staging template priority. type: string - contextPath: VersaDirector.DeviceGroup.oneTimePassword description: Device group one time password. type: string - contextPath: VersaDirector.DeviceGroup.poststaging-template description: Device group post staging template. type: string - contextPath: VersaDirector.DeviceGroup.enable-2factor-auth description: Device group enable two factor authentication. type: string - contextPath: VersaDirector.DeviceGroup.enable-staging-url description: Device group enable staging URL. type: string - name: vd-appliance-group-list description: List all appliance (device) groups associated with an organization (tenant). arguments: - name: organization description: Name of the associated organization. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.DeviceGroup.createDate description: Date the device group was created. type: string - contextPath: VersaDirector.DeviceGroup.modifyDate description: Date the device group was modified. type: string - contextPath: VersaDirector.DeviceGroup.lastUpdatedBy description: By whom the device group was last updated. type: string - contextPath: VersaDirector.DeviceGroup.name description: Device group name. type: string - contextPath: VersaDirector.DeviceGroup.organization description: Associated organization. type: string - contextPath: VersaDirector.DeviceGroup.poststagingTemplatePriority description: Post staging template priority. type: number - contextPath: VersaDirector.DeviceGroup.oneTimePassword description: One time password. type: string - contextPath: VersaDirector.DeviceGroup.poststaging-template description: Post staging template. type: string - contextPath: VersaDirector.DeviceGroup.enable-2factor-auth description: Enable two factor authentication. type: string - contextPath: VersaDirector.DeviceGroup.enable-staging-url description: Enable staging URL. type: string - contextPath: VersaDirector.DeviceGroup.inventory-name description: Inventory name. type: String - name: vd-organization-appliance-list description: List all devices associated with a specific organization. arguments: - name: organization description: Name of the associated organization. - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. Default is 0. - name: limit description: The maximum number of results to retrieve. Default is 50. outputs: - contextPath: VersaDirector.Appliance.name description: Appliance name. type: string - contextPath: VersaDirector.Appliance.uuid description: Appliance UUID. type: string - contextPath: VersaDirector.Appliance.applianceLocation description: Appliance location. type: string - name: vd-organization-list description: List all organizations/tenants. arguments: - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results to retrieve. outputs: - contextPath: VersaDirector.Organization.name description: Organization name. type: String - contextPath: VersaDirector.Organization.uuid description: Organization UUID. type: String - contextPath: VersaDirector.Organization.parent description: Organization parent. type: String - contextPath: VersaDirector.Organization.subscriptionPlan description: Organization subscription plan. type: String - contextPath: VersaDirector.Organization.id description: Organization ID. type: String - contextPath: VersaDirector.Organization.authType description: Organization auth type. type: String - contextPath: VersaDirector.Organization.cpeDeploymentType description: Organization CPE deployment type. type: String - contextPath: VersaDirector.Organization.appliances description: Organization appliances. type: String - contextPath: VersaDirector.Organization.vrfsGroups description: Organization VRFS groups. type: String - contextPath: VersaDirector.Organization.wanNetworkGroups description: Organization WAN network groups. type: String - contextPath: VersaDirector.Organization.analyticsClusters description: Organization analytics clusters. type: String - contextPath: VersaDirector.Organization.sharedControlPlane description: Organization shared control plane. type: String - contextPath: VersaDirector.Organization.blockInterRegionRouting description: Organization blockInter region routing. type: String - name: vd-appliance-list description: List all available appliances for all organizations/tenants, with a maximum of 25 appliances per organization. arguments: - name: page description: The page number of the results to retrieve. - name: page_size description: The maximum number of objects to retrieve per page. - name: limit description: The maximum number of results. outputs: - contextPath: VersaDirector.Appliance.name description: Appliance name. type: String - contextPath: VersaDirector.Appliance.uuid description: Appliance UUID. type: String - contextPath: VersaDirector.Appliance.ipAddress description: Appliance IP address. type: String - contextPath: VersaDirector.Appliance.appType description: Appliance application type. type: String - contextPath: VersaDirector.Appliance.branchId description: Application branch ID. type: Number - name: vd-auth-start description: 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. arguments: - name: auth_client_name description: Name of the Auth Client. If an excised Auth Client name will be given as an argument, an error might occur. - name: description description: Description of the access token. - name: client_id description: Client ID for Token Authentication. If already passed as a parameter it will be prioritized by default. - name: client_secret description: Client Secret for Token Authentication. If already passed as a parameter it will be prioritized by default. secret: true outputs: - contextPath: VersaDirector.AuthClient description: Auth Client Credentials. type: String - name: vd-auth-test description: Run a connectivity test to verify that the OAuth process worked. runonce: false type: python subtype: python3 dockerimage: demisto/python3:3.12.13.10116658 fromversion: 6.5.0 tests: - No tests (auto formatted)