category: Network Security provider: Thoma Bravo commonfields: id: sophos_firewall version: -1 configuration: - additionalinfo: 'Server URL used to enter the Sophos XG Firewall web console. e.g., https://ip:port/' display: Server URL name: server_url required: true type: 0 - display: User Credentials name: credentials required: true type: 9 - display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Use system proxy settings name: proxy type: 8 required: false description: On-premise firewall by Sophos enables you to manage your firewall, respond to threats, and monitor what’s happening on your network. display: Sophos Firewall name: sophos_firewall script: commands: - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all firewall rules. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-rule-list outputs: - contextPath: SophosFirewall.SecurityPolicy.Name description: Name of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Status description: Status of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.PolicyType description: Policy type of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.IPFamily description: IP family of the security policy. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.SecurityPolicy.AttachIdentity description: Rule attach identity status. type: String - contextPath: SophosFirewall.SecurityPolicy.Action description: Current rule action. type: String - contextPath: SophosFirewall.SecurityPolicy.LogTraffic description: Rule traffic logging code. type: Number - arguments: - description: Name of the rule to get. name: name required: true description: Gets a single firewall rule by name. name: sophos-firewall-rule-get outputs: - contextPath: SophosFirewall.SecurityPolicy.Name description: Name of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Status description: Status of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.PolicyType description: Policy type of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.IPFamily description: IP family of the security policy. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.SecurityPolicy.AttachIdentity description: Rule attach identity status. type: String - contextPath: SophosFirewall.SecurityPolicy.Action description: Current rule action. type: String - contextPath: SophosFirewall.SecurityPolicy.LogTraffic description: Rule traffic logging code. type: Number - arguments: - description: Name of the new rule. name: name required: true - description: Description of the new rule. name: description - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable the new rule. Possible values: "Enable" and "Disable". Default is "Enable".' name: status predefined: - Enable - Disable - auto: PREDEFINED defaultValue: IPv4 description: 'The IP family. Possible values: "IPv4" and "IPv6". Default is "IPv4".' name: ip_family predefined: - IPv4 - IPv6 - auto: PREDEFINED description: 'The position of the new rule in the list. Possible values: "top", "bottom", "before", and "after". If "before" or "after" is selected, you must provide a value for the position_policy_name argument.' name: position predefined: - top - bottom - after - before required: true - description: 'The name of the policy that the rule should be created before or after. This argument is required when the value of the position argument is "before" or "after".' name: position_policy_name - auto: PREDEFINED description: 'Policy type of the new rule. Possible values: "User" and "Network".' name: policy_type predefined: - User - Network required: true - auto: PREDEFINED description: 'Source zones to add to the rule. Possible values: "Any", "LAN". "WAN", "VPN", "DMZ", and "WiFi".' isArray: true name: source_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - description: Source networks to add to the rule. isArray: true name: source_networks - auto: PREDEFINED description: 'Destination zones to add to the rule. Possible values: "Any", "LAN". "WAN", "VPN", "DMZ", and "WiFi".' isArray: true name: destination_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - description: Destination networks to add to the rule. isArray: true name: destination_networks - description: Destination services to add to the rule. isArray: true name: services - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available from the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable traffic logging for the policy. Possible values: "Enable" and "Disable". Default is "Disable".' name: log_traffic predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to check if the specified user/user group from the\ \ selected zone is allowed to access the selected service. Possible values: "Enable" and "Disable". Default is "Disable". When enabling match_identity, the members argument is required.' name: match_identity predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to accept traffic from unknown users. The captive portal page\ \ is displayed to the user where the user can log in to access the Internet.\ \ Possible values: "Enable" and "Disable". Default is "Disable". To enable this argument, the match_identity argument must be enabled and the value of the policy_type is "User".' name: show_captive_portal predefined: - Enable - Disable - description: An existing user(s) or group(s) to add to the rule. This argument is required when match_identity is enabled. isArray: true name: members - auto: PREDEFINED defaultValue: Drop description: 'Action for the rule traffic. Possible values: "Accept", "Reject", and "Drop". Default is "Drop".' name: action predefined: - Accept - Reject - Drop - description: The DSCP marking level to classify the flow of packets based on the Traffic Shaping policy. name: dscp_marking - description: The primary gateway. Applicable only in case of multiple gateways. name: primary_gateway - description: The backup gateway. Applicable only in case of multiple gateways. name: backup_gateway - defaultValue: Allow All description: The Application Filter policy for the rule. Default is "Allow All". name: application_control - auto: PREDEFINED defaultValue: Revoke description: 'Whether to limit the bandwidth for the applications categorized\ \ under the Application category. This tag is only applicable when\ \ an application_control is selected. Possible values: "Apply" and "Revoke". Default is "Revoke".' name: application_based_qos_policy predefined: - Apply - Revoke - defaultValue: Allow All description: The Web Filter policy for the rule. Default is "Allow All". name: web_filter - auto: PREDEFINED defaultValue: Revoke description: 'Whether to limit the bandwidth for the URLs categorized under the Web\ \ category. This tag is only applicable when a web_filter is defined." Possible values: "Apply" and "Revoke". Default is "Revoke".' name: web_category_base_qos_policy predefined: - Apply - Revoke - defaultValue: None description: The Traffic Shaping policy for the rule. Default is "None". name: traffic_shaping_policy - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable virus and spam scanning for the HTTP protocol. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_http predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable virus and spam scanning for the HTTPS protocol. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_https predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable sandstorm analysis. Possible values: "Enable" and "Disable". Default is "Disable".' name: sandstorm predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable Google websites to use HTTP/s instead of QUICK QUIC. Possible values: "Enable" and "Disable". Default is "Disable".' name: block_quick_quic predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable scanning of FTP traffic. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_ftp predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to exclude a user''s network traffic from data accounting. This option is available only if the match_identity argument is enabled. Possible values: "Enable" and "Disable". Default is "Disable".' name: data_accounting predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable the NAT policy. Possible values: "Enable" and "Disable". Default is "Enable".' name: rewrite_source_address predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the Internet scheme to apply the user-based Web Filter policy for the rule. Possible values: "Enable" and "Disable". Default is "Disable".' name: web_filter_internet_scheme predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the Internet scheme to apply user-based Application Filter policy for the rule. Possible values: "Enable" and "Disable". Default is "Disable".' name: application_control_internet_scheme predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to override the gateway of the default NAT policy. Possible values: "Enable" and "Disable". Default is "Disable".' name: override_gateway_default_nat_policy predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the source security heartbeat. Possible values: "Enable" and "Disable". Default is "Disable".' name: source_security_heartbeat predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the destination security heartbeat. Possible values: "Enable" and "Disable". Default is "Disable".' name: destination_security_heartbeat predefined: - Enable - Disable - defaultValue: MASQ description: The NAT policy to apply. Default is "MASQ". name: outbound_address - defaultValue: No Restriction description: The minimum source health status permitted. Default is "No Restriction". name: minimum_source_hb_permitted - defaultValue: No Restriction description: The minimum destination health status permitted. Default is "No Restriction". name: minimum_destination_hb_permitted - defaultValue: generalpolicy description: The IPS policy for the rule. Default is "generalpolicy". name: intrusion_prevention description: Adds a new firewall rule. name: sophos-firewall-rule-add outputs: - contextPath: SophosFirewall.SecurityPolicy.Name description: Name of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Status description: Status of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.PolicyType description: Policy type of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.IPFamily description: IP family of the security policy. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.SecurityPolicy.AttachIdentity description: Rule attach identity status. type: String - contextPath: SophosFirewall.SecurityPolicy.Action description: Current rule action. type: String - contextPath: SophosFirewall.SecurityPolicy.LogTraffic description: Rule traffic logging code. type: Number - arguments: - description: Name of the new rule. name: name required: true - description: Description of the new rule. name: description - auto: PREDEFINED defaultValue: Enable description: 'Whether the rule is enabled. Possible values: "Enable" and "Disable". Default is "Enable".' name: status predefined: - Enable - Disable - auto: PREDEFINED defaultValue: IPv4 description: 'The IP family. Possible values: "IPv4" and "IPv6". Default is "IPv4".' name: ip_family predefined: - IPv4 - IPv6 - auto: PREDEFINED description: 'The position of the new rule in the list. Possible values: "top", "bottom", "before", and "after". If "before" or "after" is selected, you must provide a value for the position_policy_name argument.' name: position predefined: - top - bottom - after - before - description: 'The name of the policy that the rule should be created before or after. This argument is required when the value of the position argument is "before" or "after".' name: position_policy_name - auto: PREDEFINED description: 'Policy type of the new rule. Possible values: "User" and "Network".' name: policy_type predefined: - User - Network - auto: PREDEFINED description: 'Source zones to add to the rule. Possible values: "Any", "LAN". "WAN", "VPN", "DMZ", and "WiFi".' isArray: true name: source_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - description: Source networks to add to the rule. isArray: true name: source_networks - auto: PREDEFINED description: 'Destination zones to add to the rule. Possible values: "Any", "LAN". "WAN", "VPN", "DMZ", and "WiFi".' isArray: true name: destination_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - description: Destination networks to add to the rule. isArray: true name: destination_networks - description: Destination services to add to the rule. isArray: true name: services - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available in the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable traffic logging for the policy. Possible values: "Enable" and "Disable". Default is "Disable".' name: log_traffic predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to check if the specified user/user group from the\ \ selected zone is allowed to access the selected service. Possible values: "Enable" and "Disable". Default is "Disable". IMPORTANT: When enabling match_identity, the members argument is required.' name: match_identity predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to accept traffic from unknown users. The captive portal page\ \ is displayed to the user where the user can log in to access the Internet.\ \ Possible values: "Enable" and "Disable". Default is "Disable". To enable this argument, the match_identity argument must be enabled and the value of the policy_type is "User".' name: show_captive_portal predefined: - Enable - Disable - description: An existing user(s) or group(s) to add to the rule. This argument is required when match_identity is enabled. isArray: true name: members - auto: PREDEFINED defaultValue: Drop description: 'Action for the rule traffic. Possible values: "Accept", "Reject", and "Drop". Default is "Drop".' name: action predefined: - Accept - Reject - Drop - description: The DSCP marking level to classify the flow of packets based on the Traffic Shaping policy. name: dscp_marking - description: The primary gateway. Applicable only in case of multiple gateways. name: primary_gateway - description: The backup gateway. Applicable only in case of multiple gateways. name: backup_gateway - defaultValue: Allow All description: The Application Filter policy for the rule. Default is "Allow All". name: application_control - auto: PREDEFINED defaultValue: Revoke description: 'Whether to limit the bandwidth for the applications categorized\ \ under the Application category. This tag is only applicable when\ \ an application_control is selected. Possible values: "Apply" and "Revoke". Default is "Revoke".' name: application_based_qos_policy predefined: - Apply - Revoke - defaultValue: Allow All description: The Web Filter policy for the rule. Default is "Allow All". name: web_filter - auto: PREDEFINED defaultValue: Revoke description: 'Whether to limit the bandwidth for the URLs categorized under the Web\ \ category. This tag is only applicable when a web_filter is defined." Possible values: "Apply" and "Revoke". Default is "Revoke".' name: web_category_base_qos_policy predefined: - Apply - Revoke - defaultValue: None description: The Traffic Shaping policy for the rule. Default is "None". name: traffic_shaping_policy - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable virus and spam scanning for HTTP protocol. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_http predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable virus and spam scanning for HTTPS protocol. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_https predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable sandstorm analysis. Possible values: "Enable" and "Disable". Default is "Disable".' name: sandstorm predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable Google websites to use HTTP/s instead of QUICK QUIC. Possible values: "Enable" and "Disable". Default is "Disable".' name: block_quick_quic predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable scanning of FTP traffic. Possible values: "Enable" and "Disable". Default is "Disable".' name: scan_ftp predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to exclude a user''s network traffic from data accounting. This option is available only if the match_identity argument is enabled. Possible values: "Enable" and "Disable". Default is "Disable".' name: data_accounting predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable the NAT policy. Possible values: "Enable" and "Disable". Default is "Enable".' name: rewrite_source_address predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the Internet scheme to apply the user-based Web Filter policy for the rule. Possible values: "Enable" and "Disable". Default is "Disable".' name: web_filter_internet_scheme predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the Internet scheme to apply user-based Application Filter Policy for the rule. Possible values: "Enable" and "Disable". Default is "Disable".' name: application_control_internet_scheme predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to override the gateway of the default NAT policy. Possible values: "Enable" and "Disable". Default is "Disable".' name: override_gateway_default_nat_policy predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the source security heartbeat. Possible values: "Enable" and "Disable". Default is "Disable".' name: source_security_heartbeat predefined: - Enable - Disable - auto: PREDEFINED defaultValue: Disable description: 'Whether to enable the destination security heartbeat. Possible values: "Enable" and "Disable". Default is "Disable".' name: destination_security_heartbeat predefined: - Enable - Disable - defaultValue: MASQ description: The NAT policy to be applied. Default is "MASQ". name: outbound_address - defaultValue: No Restriction description: The minimum source health status permitted. Default is "No Restriction". name: minimum_source_hb_permitted - defaultValue: No Restriction description: The minimum destination health status permitted. Default is "No Restriction". name: minimum_destination_hb_permitted - defaultValue: generalpolicy description: The IPS policy for the rule. Default is "generalpolicy". name: intrusion_prevention description: Updates an existing firewall rule. name: sophos-firewall-rule-update outputs: - contextPath: SophosFirewall.SecurityPolicy.Name description: Name of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.Status description: Status of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.PolicyType description: Policy type of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.IPFamily description: IP family of the security policy. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.SecurityPolicy.AttachIdentity description: Rule attach identity status. type: String - contextPath: SophosFirewall.SecurityPolicy.Action description: Current rule action. type: String - contextPath: SophosFirewall.SecurityPolicy.LogTraffic description: Rule traffic logging code. type: Number - arguments: - description: Name of the rule. name: name required: true description: Deletes an existing firewall rule. name: sophos-firewall-rule-delete outputs: - contextPath: SophosFirewall.SecurityPolicy.Name description: Name of the rule. type: String - contextPath: SophosFirewall.SecurityPolicy.IsDeleted description: Whether the rule is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all firewall rule groups. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-rule-group-list outputs: - contextPath: SophosFirewall.SecurityPolicyGroup.Name description: Name of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.Description description: Description of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SecurityPolicyList.SecurityPolicy description: Rules contained inside the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SourceZones.Zone description: Source zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.DestinationZones.Zone description: Destination zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.PolicyType description: Type of the rules in the group. type: Number - arguments: - description: Name of the firewall rule group. name: name description: Gets a single firewall rule group by name. name: sophos-firewall-rule-group-get outputs: - contextPath: SophosFirewall.SecurityPolicyGroup.Name description: Name of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.Description description: Description of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SecurityPolicyList.SecurityPolicy description: Rules contained inside the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SourceZones.Zone description: Source zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.DestinationZones.Zone description: Destination zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.PolicyType description: Type of the rules in the group. type: Number - arguments: - description: Name of the rule group. name: name required: true - description: Description of the rule group. name: description - auto: PREDEFINED description: 'Type of the rules (policies) inside the group. Possible values: "Any", "User/network rule", "User rule", and "Business application rule".' name: policy_type predefined: - Any - User/network rule - Network rule - User rule - Business application rule - description: Rules contained in the group. isArray: true name: rules - auto: PREDEFINED description: 'Source zones contained in the group. Possible values: "Any", "LAN", "WAN", "VPN", "DMZ", and "WiFi.' isArray: true name: source_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - auto: PREDEFINED description: 'Destination zones contained in the group. Possible values: "Any", "LAN", "WAN", "VPN", "DMZ", and "WiFi.' isArray: true name: destination_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi description: Adds a new firewall rule group. name: sophos-firewall-rule-group-add outputs: - contextPath: SophosFirewall.SecurityPolicyGroup.Name description: Name of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.Description description: Description of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SecurityPolicyList.SecurityPolicy description: Rules contained in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SourceZones.Zone description: Source zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.DestinationZones.Zone description: Destination zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.PolicyType description: Type of the rules in the group. type: Number - arguments: - description: Name of the rule group. name: name required: true - description: Description of the rule group. name: description - auto: PREDEFINED description: 'Type of the rules (policies) inside the group. Possible values: "Any", "User/network rule", "User rule", and "Business application rule".' name: policy_type predefined: - Any - User/network rule - Network rule - User rule - Business application rule - description: Rules contained in the group. isArray: true name: rules - auto: PREDEFINED description: 'Source zones contained in the group. Possible values: "Any", "LAN", "WAN", "VPN", "DMZ", and "WiFi.' isArray: true name: source_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi - auto: PREDEFINED description: 'Destination zones contained in the group. Possible values: "Any", "LAN", "WAN", "VPN", "DMZ", and "WiFi.' isArray: true name: destination_zones predefined: - Any - LAN - WAN - VPN - DMZ - WiFi description: Updates an existing firewall rule group. name: sophos-firewall-rule-group-update outputs: - contextPath: SophosFirewall.SecurityPolicyGroup.Name description: Name of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.Description description: Description of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SecurityPolicyList.SecurityPolicy description: Rules contained in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.SourceZones.Zone description: Source zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.DestinationZones.Zone description: Destination zone in the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.PolicyType description: Type of the rules in the group. type: Number - arguments: - description: Name of the group. name: name required: true description: Deletes an existing firewall group. name: sophos-firewall-rule-group-delete outputs: - contextPath: SophosFirewall.SecurityPolicyGroup.Name description: Name of the group. type: String - contextPath: SophosFirewall.SecurityPolicyGroup.IsDeleted description: Whether the group is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all URL groups. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-url-group-list outputs: - contextPath: SophosFirewall.WebFilterURLGroup.Name description: Name of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.Description description: Description of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.URLlist.URL description: URL contained in the group. type: String - arguments: - description: Name of the group. isArray: true name: name required: true description: Gets a single URL group by name. name: sophos-firewall-url-group-get outputs: - contextPath: SophosFirewall.WebFilterURLGroup.Name description: Name of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.Description description: Description of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.URLlist.URL description: URL contained in the group. type: String - arguments: - description: Name of the group. isArray: true name: name required: true - description: Description of the group. name: description - description: Comma-separated list of URLs to add to the group. isArray: true name: urls required: true description: Adds new URLs to the group. name: sophos-firewall-url-group-add outputs: - contextPath: SophosFirewall.WebFilterURLGroup.Name description: Name of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.Description description: Description of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.URLlist.URL description: URL contained in the group. type: String - arguments: - description: Name of the group. isArray: true name: name required: true - description: Description of the group. name: description - description: Comma-separated list of URLs to add to the group. isArray: true name: urls description: Updates an existing URL group. name: sophos-firewall-url-group-update outputs: - contextPath: SophosFirewall.WebFilterURLGroup.Name description: Name of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.Description description: Description of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.URLlist.URL description: URL contained in the group. type: String - arguments: - description: Name of the group(s). isArray: true name: name required: true description: Deletes an existing URL group or groups. name: sophos-firewall-url-group-delete outputs: - contextPath: SophosFirewall.WebFilterURLGroup.Name description: Name of the URL group. type: String - contextPath: SophosFirewall.WebFilterURLGroup.IsDeleted description: Whether the URL group is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all IP hosts. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-ip-host-list outputs: - contextPath: SophosFirewall.IPHost.Name description: Name of the IP host. type: String - contextPath: SophosFirewall.IPHost.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.IPHost.HostType description: Type of the host. type: String - arguments: - description: Name of the IP host. name: name required: true description: Gets a single IP host by name. name: sophos-firewall-ip-host-get outputs: - contextPath: SophosFirewall.IPHost.Name description: Name of the IP host. type: String - contextPath: SophosFirewall.IPHost.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.IPHost.HostType description: Type of the host. type: String - arguments: - description: Name of the IP host. name: name required: true - auto: PREDEFINED description: 'Type of the host. Possible values: "IP", "Network", "IPRange", and "IPList".' name: host_type predefined: - IP - Network - IPRange - IPList required: true - auto: PREDEFINED defaultValue: IPv4 description: 'The IP family. Possible values: "IPv4" and "IPv6". Default is "IPv4".' name: ip_family predefined: - IPv4 - IPv6 - description: IP address if IP or Network was the chosen host_type. name: ip_address - description: Subnet mask if Network was the chosen host_type. name: subnet_mask - description: Start of the IP range if IPRange was the chosen host_type. name: start_ip - description: End of the IP range if IPRange was the chosen host_type. name: end_ip - description: List of IP addresses if IPList was the chosen host_type. isArray: true name: ip_addresses - description: Select the host group to which the host belongs. isArray: true name: host_group description: Adds a new IP host. name: sophos-firewall-ip-host-add outputs: - contextPath: SophosFirewall.IPHost.Name description: Name of the IP host. type: String - contextPath: SophosFirewall.IPHost.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.IPHost.HostType description: Type of the host. type: String - arguments: - description: Name of the IP host. name: name required: true - auto: PREDEFINED description: 'Type of the host. Possible values: "IP", "Network", "IPRange", and "IPList".' name: host_type predefined: - IP - Network - IPRange - IPList - auto: PREDEFINED defaultValue: IPv4 description: 'The IP family. Possible values: "IPv4" and "IPv6". Default is "IPv4".' name: ip_family predefined: - IPv4 - IPv6 - description: IP address if IP or Network was the chosen host_type. name: ip_address - description: Subnet mask if Network was the chosen host_type. name: subnet_mask - description: Start of the IP range if IPRange was the chosen host_type. name: start_ip - description: End of the IP range if IPRange was the chosen host_type. name: end_ip - description: List of IP addresses if IPList was the chosen host_type. isArray: true name: ip_addresses - description: Select the host group to which the host belongs. isArray: true name: host_group description: Updates an existing IP host. name: sophos-firewall-ip-host-update outputs: - contextPath: SophosFirewall.IPHost.Name description: Name of the IP host. type: String - contextPath: SophosFirewall.IPHost.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - contextPath: SophosFirewall.IPHost.HostType description: Type of the host. type: String - arguments: - description: Name of the host. name: name required: true description: Deletes an existing IP host. name: sophos-firewall-ip-host-delete outputs: - contextPath: SophosFirewall.IPHost.Name description: Name of the IP host. type: String - contextPath: SophosFirewall.IPHost.IsDeleted description: Whether the IP host is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all IP host groups. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-ip-host-group-list outputs: - contextPath: SophosFirewall.IPHostGroup.Name description: Name of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.description description: Description of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.HostList.Host description: Host contained in the host group. type: String - contextPath: SophosFirewall.IPHostGroup.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - arguments: - description: Name of the IP host group. name: name required: true description: Gets a single IP host group by name. name: sophos-firewall-ip-host-group-get outputs: - contextPath: SophosFirewall.IPHostGroup.Name description: Name of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.description description: Description of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.HostList.Host description: Host contained inside the host group. type: String - contextPath: SophosFirewall.IPHostGroup.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - arguments: - description: Name of the IP host group. name: name required: true - description: Description of the IP host group. name: description - auto: PREDEFINED description: 'The IP family. Possible values: "IPv4" and "IPv6".' name: ip_family predefined: - IPv4 - IPv6 - description: IP hosts contained in the group. Must be hosts that exist in the system. isArray: true name: hosts description: Adds a new IP host group. name: sophos-firewall-ip-host-group-add outputs: - contextPath: SophosFirewall.IPHostGroup.Name description: Name of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.description description: Description of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.HostList.Host description: Host contained in the host group. type: String - contextPath: SophosFirewall.IPHostGroup.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - arguments: - description: Name of the IP host group. name: name required: true - description: Description of the IP host group. name: description - auto: PREDEFINED description: 'The IP family. Possible values: "IPv4" and "IPv6".' name: ip_family predefined: - IPv4 - IPv6 - description: IP hosts contained in the group. Must be hosts that exist in the system. isArray: true name: hosts description: Updates an existing IP host group. name: sophos-firewall-ip-host-group-update outputs: - contextPath: SophosFirewall.IPHostGroup.Name description: Name of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.description description: Description of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.HostList.Host description: Host contained inside the host group. type: String - contextPath: SophosFirewall.IPHostGroup.IPFamily description: IP family of the host group. Either IPv4 or IPv6. type: String - arguments: - description: Name of the group. name: name required: true description: Deletes an existing IP host group. name: sophos-firewall-ip-host-group-delete outputs: - contextPath: SophosFirewall.IPHostGroup.Name description: Name of the IP host group. type: String - contextPath: SophosFirewall.IPHostGroup.IsDeleted description: Whether the IP host group is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all firewall services. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-services-list outputs: - contextPath: SophosFirewall.Services.Name description: Name of the firewall service. type: String - contextPath: SophosFirewall.Services.Type description: Type of the firewall service. type: String - contextPath: SophosFirewall.Services.ServiceDetails.ServiceDetail description: Details about the service. type: String - arguments: - description: Name of the firewall service. name: name required: true description: Gets a single service by name. name: sophos-firewall-services-get outputs: - contextPath: SophosFirewall.Services.Name description: Name of the firewall service. type: String - contextPath: SophosFirewall.Services.Type description: Type of the firewall service. type: String - contextPath: SophosFirewall.Services.ServiceDetails.ServiceDetail description: Details about the service. type: String - arguments: - description: Name of the firewall service. name: name required: true - auto: PREDEFINED description: 'Type of service. Possible values: "TCPorUDP", "IP", "ICMP", and "ICMPv6".' name: service_type predefined: - TCPorUDP - IP - ICMP - ICMPv6 required: true - auto: PREDEFINED description: 'The protocol for the service if service_type is TCPorUDP. Possible values: "TCP" and "UDP".' name: protocol predefined: - TCP - UDP - description: 'Source port if service_type is TCPorUDP.' name: source_port - description: 'Destination port if service_type is TCPorUDP.' name: destination_port - auto: PREDEFINED description: Protocol name if service_type is IP. name: protocol_name predefined: - HOPOPT - ICMP - IGMPGGP - IP - ST - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - ARGUS - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPRXTP - DDP - IDPR-CMTP - TP++ - IL - IPv6 - SDRP - IPv6-Route - IPv6-Frag - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - SWIPE - NARP - MOBILE - TLSP - SKIP - IPv6-ICMP - IPv6-NoNxt - IPv6-Opts - IPProto61 - CFTP - IPProto63 - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - IPProto68 - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - '25' - IPIP - MICP - SCC-SP - ETHERIP - ENCAP - IPProto99 - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A - N - IPComp - SNP - Compaq-Peer - IPX-in-IP - VRRP - PGM - IPProto114 - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - ISIS - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - IPProto135 - UDPLite - MPLS-in-IP - manet - HIP - Shim6 - WESP - ROHC - IPProto143 - IPProto144 - IPProto145 - IPProto146 - IPProto147 - IPProto148 - IPProto149 - IPProto150 - IPProto151 - IPProto152 - IPProto153 - IPProto154 - IPProto155 - IPProto156 - IPProto157 - IPProto158 - IPProto159 - IPProto160 - IPProto161 - IPProto162 - IPProto163 - IPProto164 - IPProto165 - IPProto166 - IPProto167 - IPProto168 - IPProto169 - IPProto170 - IPProto171 - IPProto172 - IPProto173 - IPProto174 - IPProto175 - IPProto176 - IPProto177 - IPProto178 - IPProto179 - IPProto180 - IPProto181 - IPProto182 - IPProto183 - IPProto184 - IPProto185 - IPProto186 - IPProto187 - IPProto188 - IPProto189 - IPProto190 - IPProto191 - IPProto192 - IPProto193 - IPProto194 - IPProto195 - IPProto196 - IPProto197 - IPProto198 - IPProto199 - IPProto200 - IPProto201 - IPProto202 - IPProto203 - IPProto204 - IPProto205 - IPProto206 - IPProto207 - IPProto208 - IPProto209 - IPProto210 - IPProto211 - IPProto212 - IPProto213 - IPProto214 - IPProto215 - IPProto216 - IPProto217 - IPProto218 - IPProto219 - IPProto220 - IPProto221 - IPProto222 - IPProto223 - IPProto224 - IPProto225 - IPProto226 - IPProto227 - IPProto228 - IPProto229 - IPProto230 - IPProto231 - IPProto232 - IPProto233 - IPProto234 - IPProto235 - IPProto236 - IPProto237 - IPProto238 - IPProto239 - IPProto240 - IPProto241 - IPProto242 - IPProto243 - IPProto244 - IPProto245 - IPProto246 - IPProto247 - IPProto248 - IPProto249 - IPProto250 - IPProto251 - IPProto252 - IPProto253 - IPProto254 - IPProto255 - auto: PREDEFINED description: ICMP type if service_type is ICMP. name: icmp_type predefined: - Echo Reply - Destination Unreachable - Source Quench - Redirect - Alternate Host Address - Echo - Router Advertisement - Router Selection - Time Exceeded - Parameter Problem - Timestamp - Timestamp Reply - Information Request - Information Reply - Address Mask Request - Address Mask Reply - Traceroute - Datagram Conversion Error - Mobile Host Redirect - IPv6 Where-Are-You - IPv6 I-Am-Here - Mobile Registration Request - Mobile Registration Reply - Domain Name Request - Domain Name Reply - SKIP - Photuris - Any Type - auto: PREDEFINED description: ICMP code if service_type is ICMP. name: icmp_code predefined: - '0' - '-1' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - auto: PREDEFINED description: ICMPv6 type if service_type is ICMPv6. name: icmp_v6_type predefined: - Destination Unreachable - Packet Too Big - Time Exceeded - Parameter Problem - Private experimentation - Private experimentation - Echo Request - Echo Reply - Multicast Listener Query - Multicast Listener Report - Multicast Listener Done - Router Solicitation - Router Advertisement - Neighbor Solicitation - Neighbor Advertisement - Redirect Message - Router Renumbering - ICMP Node Information Query - ICMP Node Information Response - Inverse Neighbor Discovery Solicitation Message - Inverse Neighbor Discovery Advertisement Message - Version 2 Multicast Listener Report - Home Agent Address Discovery Request Message - Home Agent Address Discovery Reply Message - Mobile Prefix Solicitation - Mobile Prefix Advertisement - Certification Path Solicitation Message - Certification Path Advertisement Message - ICMP messages utilized by experimental mobility protocols such as Seamoby - Multicast Router Advertisement - Multicast Router Solicitation - Multicast Router Termination - FMIPv6 Messages - RPL Control Message - ILNPv6 Locator Update Message - Duplicate Address Request - Duplicate Address Confirmation - Private experimentation - Private experimentation - Any Type - auto: PREDEFINED description: ICMPv6 code if service_type is ICMPv6. name: icmp_v6_code predefined: - '0' - '-1' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' description: Adds a new firewall service. name: sophos-firewall-services-add outputs: - contextPath: SophosFirewall.Services.Name description: Name of the firewall service. type: String - contextPath: SophosFirewall.Services.Type description: Type of the firewall service. type: String - contextPath: SophosFirewall.Services.ServiceDetails.ServiceDetail description: Details about the service. type: String - arguments: - description: Name of the firewall service. name: name required: true - auto: PREDEFINED description: 'Type of service. Possible values: "TCPorUDP", "IP", "ICMP", and "ICMPv6".' name: service_type predefined: - TCPorUDP - IP - ICMP - ICMPv6 - auto: PREDEFINED description: 'The protocol for the service if service_type is TCPorUDP. Possible values: "TCP" and "UDP".' name: protocol predefined: - TCP - UDP - description: 'Source port if service_type is TCPorUDP.' name: source_port - description: 'Destination port if service_type is TCPorUDP.' name: destination_port - auto: PREDEFINED description: Protocol name if service_type is IP. name: protocol_name predefined: - HOPOPT - ICMP - IGMPGGP - IP - ST - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - ARGUS - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPRXTP - DDP - IDPR-CMTP - TP++ - IL - IPv6 - SDRP - IPv6-Route - IPv6-Frag - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - SWIPE - NARP - MOBILE - TLSP - SKIP - IPv6-ICMP - IPv6-NoNxt - IPv6-Opts - IPProto61 - CFTP - IPProto63 - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - IPProto68 - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - '25' - IPIP - MICP - SCC-SP - ETHERIP - ENCAP - IPProto99 - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A - N - IPComp - SNP - Compaq-Peer - IPX-in-IP - VRRP - PGM - IPProto114 - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - ISIS - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - IPProto135 - UDPLite - MPLS-in-IP - manet - HIP - Shim6 - WESP - ROHC - IPProto143 - IPProto144 - IPProto145 - IPProto146 - IPProto147 - IPProto148 - IPProto149 - IPProto150 - IPProto151 - IPProto152 - IPProto153 - IPProto154 - IPProto155 - IPProto156 - IPProto157 - IPProto158 - IPProto159 - IPProto160 - IPProto161 - IPProto162 - IPProto163 - IPProto164 - IPProto165 - IPProto166 - IPProto167 - IPProto168 - IPProto169 - IPProto170 - IPProto171 - IPProto172 - IPProto173 - IPProto174 - IPProto175 - IPProto176 - IPProto177 - IPProto178 - IPProto179 - IPProto180 - IPProto181 - IPProto182 - IPProto183 - IPProto184 - IPProto185 - IPProto186 - IPProto187 - IPProto188 - IPProto189 - IPProto190 - IPProto191 - IPProto192 - IPProto193 - IPProto194 - IPProto195 - IPProto196 - IPProto197 - IPProto198 - IPProto199 - IPProto200 - IPProto201 - IPProto202 - IPProto203 - IPProto204 - IPProto205 - IPProto206 - IPProto207 - IPProto208 - IPProto209 - IPProto210 - IPProto211 - IPProto212 - IPProto213 - IPProto214 - IPProto215 - IPProto216 - IPProto217 - IPProto218 - IPProto219 - IPProto220 - IPProto221 - IPProto222 - IPProto223 - IPProto224 - IPProto225 - IPProto226 - IPProto227 - IPProto228 - IPProto229 - IPProto230 - IPProto231 - IPProto232 - IPProto233 - IPProto234 - IPProto235 - IPProto236 - IPProto237 - IPProto238 - IPProto239 - IPProto240 - IPProto241 - IPProto242 - IPProto243 - IPProto244 - IPProto245 - IPProto246 - IPProto247 - IPProto248 - IPProto249 - IPProto250 - IPProto251 - IPProto252 - IPProto253 - IPProto254 - IPProto255 - auto: PREDEFINED description: ICMP type if service_type is ICMP. name: icmp_type predefined: - Echo Reply - Destination Unreachable - Source Quench - Redirect - Alternate Host Address - Echo - Router Advertisement - Router Selection - Time Exceeded - Parameter Problem - Timestamp - Timestamp Reply - Information Request - Information Reply - Address Mask Request - Address Mask Reply - Traceroute - Datagram Conversion Error - Mobile Host Redirect - IPv6 Where-Are-You - IPv6 I-Am-Here - Mobile Registration Request - Mobile Registration Reply - Domain Name Request - Domain Name Reply - SKIP - Photuris - Any Type - auto: PREDEFINED description: ICMP code if service_type is ICMP. name: icmp_code predefined: - '0' - '-1' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - auto: PREDEFINED description: ICMPv6 type if service_type is ICMPv6. name: icmp_v6_type predefined: - Destination Unreachable - Packet Too Big - Time Exceeded - Parameter Problem - Private experimentation - Private experimentation - Echo Request - Echo Reply - Multicast Listener Query - Multicast Listener Report - Multicast Listener Done - Router Solicitation - Router Advertisement - Neighbor Solicitation - Neighbor Advertisement - Redirect Message - Router Renumbering - ICMP Node Information Query - ICMP Node Information Response - Inverse Neighbor Discovery Solicitation Message - Inverse Neighbor Discovery Advertisement Message - Version 2 Multicast Listener Report - Home Agent Address Discovery Request Message - Home Agent Address Discovery Reply Message - Mobile Prefix Solicitation - Mobile Prefix Advertisement - Certification Path Solicitation Message - Certification Path Advertisement Message - ICMP messages utilized by experimental mobility protocols such as Seamoby - Multicast Router Advertisement - Multicast Router Solicitation - Multicast Router Termination - FMIPv6 Messages - RPL Control Message - ILNPv6 Locator Update Message - Duplicate Address Request - Duplicate Address Confirmation - Private experimentation - Private experimentation - Any Type - auto: PREDEFINED description: ICMPv6 code if service_type is ICMPv6. name: icmp_v6_code predefined: - '0' - '-1' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' description: Updates an existing firewall service. name: sophos-firewall-services-update outputs: - contextPath: SophosFirewall.Services.Name description: Name of the firewall service. type: String - contextPath: SophosFirewall.Services.Type description: Type of the firewall service. type: String - contextPath: SophosFirewall.Services.ServiceDetails.ServiceDetail description: Details about the service. type: String - arguments: - description: Name of the service. name: name required: true description: Deletes an existing firewall service. name: sophos-firewall-services-delete outputs: - contextPath: SophosFirewall.Services.Name description: Name of the firewall service. type: String - contextPath: SophosFirewall.Services.IsDeleted description: Whether the firewall service is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all users. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-user-list outputs: - contextPath: SophosFirewall.User.Name description: Name of the user. type: String - contextPath: SophosFirewall.User.Username description: Username of the user. type: String - contextPath: SophosFirewall.User.Description description: Description of the user. type: String - contextPath: SophosFirewall.User.EmailList.EmailID description: Email of the user. type: String - contextPath: SophosFirewall.User.Group description: Group of the user. type: String - contextPath: SophosFirewall.User.UserType description: User type of the user. type: String - contextPath: SophosFirewall.User.Status description: Status of the user. type: String - arguments: - description: Name of the user. name: name required: true description: Gets a single user by name. name: sophos-firewall-user-get outputs: - contextPath: SophosFirewall.User.Name description: Name of the user. type: String - contextPath: SophosFirewall.User.Username description: Username of the user. type: String - contextPath: SophosFirewall.User.Description description: Description of the user. type: String - contextPath: SophosFirewall.User.EmailList.EmailID description: Email of the user. type: String - contextPath: SophosFirewall.User.Group description: Group of the user. type: String - contextPath: SophosFirewall.User.UserType description: User type of the user. type: String - contextPath: SophosFirewall.User.Status description: Status of the user. type: String - arguments: - description: Username of the user. name: username required: true - description: Name of the user. name: name required: true - description: Description of the user. name: description - description: Email of the user. name: email required: true - defaultValue: Guest Group description: Group of the user. Default is "Guest Group". name: group - description: The password of the user. name: password required: true secret: true - auto: PREDEFINED defaultValue: User description: 'The type of the user. Possible values: "Administrator" and "User". Default is "User".' name: user_type predefined: - Administrator - User - auto: PREDEFINED description: 'Profile of the administrator if user_type is Administrator. Possible values: "Administrator", "Crypto Admin", "Security Admin", "Audit Admin", and "HAProfile". IMPORTANT: You can add more types in the web console.' name: profile predefined: - Administrator - Crypto Admin - Security Admin - Audit Admin - HAProfile - defaultValue: Unlimited Internet Access description: The Surfing Quota policy. Default is "Unlimited Internet Access". name: surfing_quota_policy - defaultValue: Allowed all the time description: The Access Time policy. Default is "Allowed all the time". name: access_time_policy - defaultValue: No Policy Applied description: The SSL VPN policy. Default is "No Policy Applied". name: ssl_vpn_policy - defaultValue: No Policy Applied description: The clientless policy. Default is "No Policy Applied". name: clientless_policy - defaultValue: 100 MB Total Data Transfer policy description: 'The Data Transfer policy. Default is: "100 MB Total Data Transfer policy".' name: data_transfer_policy - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable simultaneous logins global. Possible values: "Enable" and "Disable". Default is "Enable".' name: simultaneous_logins_global predefined: - Enable - Disable - defaultValue: All The Time description: 'The schedule for appliance access. Default is "All The Time". IMPORTANT: This option\ \ is available only for Administrators.' name: schedule_for_appliance_access - defaultValue: High Guarantee User description: The QoS policy. Default is "High Guarantee User". name: qos_policy - auto: PREDEFINED defaultValue: UserGroupNode description: 'The login restriction option. Possible values: "AnyNode" and "UserGroupNode". Default is "UserGroupNode".' name: login_restriction predefined: - AnyNode - UserGroupNode description: Adds a new user. name: sophos-firewall-user-add outputs: - contextPath: SophosFirewall.User.Name description: Name of the user. type: String - contextPath: SophosFirewall.User.Username description: Username of the user. type: String - contextPath: SophosFirewall.User.Description description: Description of the user. type: String - contextPath: SophosFirewall.User.EmailList.EmailID description: Email of the user. type: String - contextPath: SophosFirewall.User.Group description: Group of the user. type: String - contextPath: SophosFirewall.User.UserType description: User type of the user. type: String - contextPath: SophosFirewall.User.Status description: Status of the user. type: String - arguments: - description: Username of the user. name: username required: true - description: Name of the user. name: name required: true - description: Description of the user. name: description - description: Email of the user. name: email - defaultValue: Guest Group description: Group of the user. Default is "Guest Group". name: group - description: The password of the user. name: password secret: true - auto: PREDEFINED defaultValue: User description: 'The type of the user. Possible values: "Administrator" and "User". Default is "User".' name: user_type predefined: - Administrator - User - auto: PREDEFINED description: 'Profile of the administrator if user_type is Administrator. Possible values: "Administrator", "Crypto Admin", "Security Admin", "Audit Admin", and "HAProfile". IMPORTANT: You can add more types in the web console.' name: profile predefined: - Administrator - Crypto Admin - Security Admin - Audit Admin - HAProfile - defaultValue: Unlimited Internet Access description: The Surfing Quota policy. Default is "Unlimited Internet Access". name: surfing_quota_policy - defaultValue: Allowed all the time description: The Access Time policy. Default is "Allowed all the time". name: access_time_policy - defaultValue: No Policy Applied description: The SSL VPN policy. Default is "No Policy Applied". name: ssl_vpn_policy - defaultValue: No Policy Applied description: The clientless policy. Default is "No Policy Applied". name: clientless_policy - defaultValue: 100 MB Total Data Transfer policy description: 'The Data Transfer policy. Default is: "100 MB Total Data Transfer policy".' name: data_transfer_policy - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable simultaneous logins global. Possible values: "Enable" and "Disable". Default is "Enable".' name: simultaneous_logins_global predefined: - Enable - Disable - defaultValue: All The Time description: 'The schedule for appliance access. Default is "All The Time".IMPORTANT: This option\ \ is available only for Administrators.' name: schedule_for_appliance_access - defaultValue: High Guarantee User description: The QoS policy. Default is "High Guarantee User". name: qos_policy - auto: PREDEFINED defaultValue: UserGroupNode description: 'The login restriction option. Possible values: "AnyNode" and "UserGroupNode". Default is "UserGroupNode".' name: login_restriction predefined: - AnyNode - UserGroupNode description: Updates a user. name: sophos-firewall-user-update outputs: - contextPath: SophosFirewall.User.Name description: Name of the user. type: String - contextPath: SophosFirewall.User.Username description: Username of the user. type: String - contextPath: SophosFirewall.User.Description description: Description of the user. type: String - contextPath: SophosFirewall.User.EmailList.EmailID description: Email of the user. type: String - contextPath: SophosFirewall.User.Group description: Group of the user. type: String - contextPath: SophosFirewall.User.UserType description: User type of the user. type: String - contextPath: SophosFirewall.User.Status description: Status of the user. type: String - arguments: - description: Name of the user. name: name required: true description: Deletes an existing user. name: sophos-firewall-user-delete outputs: - contextPath: SophosFirewall.User.Name description: Name of the user. type: String - contextPath: SophosFirewall.User.IsDeleted description: Whether the user is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all app policies. IMPORTANT: The list starst at 0 (not 1)!' name: sophos-firewall-app-policy-list outputs: - contextPath: SophosFirewall.ApplicationFilterPolicy.Name description: Name of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.Description description: Description of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.MicroAppSupport description: Whether the policy support microapps. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.DefaultAction description: Default action the policy executes. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.RuleList.Rule description: Details of the rule. type: String - arguments: - description: Name of the policy. name: name required: true description: Gets a single app policy by name. name: sophos-firewall-app-policy-get outputs: - contextPath: SophosFirewall.ApplicationFilterPolicy.Name description: Name of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.Description description: Description of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.MicroAppSupport description: Whether the policy supports microapps. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.DefaultAction description: Default action the policy executes. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.RuleList.Rule description: Details of the rule. type: String - arguments: - description: Name of the policy. name: name required: true - description: Description of the policy. name: description - auto: PREDEFINED description: 'Whether microapp support is enabled. Possible values: "true" and "false".' name: micro_app_support predefined: - 'true' - 'false' - auto: PREDEFINED description: 'Default action for the policy. Possible values: "Allow" and "Deny".' name: default_action predefined: - Allow - Deny - auto: PREDEFINED description: 'Whether to enable the select all rule. Possible values: "Enable" and "Disable".' name: select_all predefined: - Enable - Disable - description: Categories to add to the rule. isArray: true name: categories - description: Risks to add to the rule. isArray: true name: risks - description: Applications to add to the rule. isArray: true name: applications - description: Characteristics to add to the rule. isArray: true name: characteristics - description: Technologies to add to the rule. isArray: true name: technologies - description: Classifications to add to the rule. isArray: true name: classifications - auto: PREDEFINED description: 'Action for the rule. Possible values: "Allow" and "Deny".' name: action predefined: - Allow - Deny - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available in the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 description: Adds a new app policy. name: sophos-firewall-app-policy-add outputs: - contextPath: SophosFirewall.ApplicationFilterPolicy.Name description: Name of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.Description description: Description of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.MicroAppSupport description: Whether the policy supports microapps. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.DefaultAction description: Default action the policy executes. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.RuleList.Rule description: Details of the rule. type: String - arguments: - description: Name of the policy. name: name required: true - description: Description of the policy. name: description - auto: PREDEFINED description: 'Whether microapp support is enabled. Possible values: "true" and "false".' name: micro_app_support predefined: - 'true' - 'false' - auto: PREDEFINED description: 'Default action for the policy. Possible values: "Allow" and "Deny".' name: default_action predefined: - Allow - Deny - auto: PREDEFINED description: 'Whether to enable the select all rule. Possible values: "Enable" and "Disable".' name: select_all predefined: - Enable - Disable - description: Categories to add to the rule. isArray: true name: categories - description: Risks to add to the rule. isArray: true name: risks - description: Applications to add to the rule. isArray: true name: applications - description: Characteristics to add to the rule. isArray: true name: characteristics - description: Technologies to add to the rule. isArray: true name: technologies - description: Classifications to add to the rule. isArray: true name: classifications - auto: PREDEFINED description: 'Action for the rule. Possible values: "Allow" and "Deny".' name: action predefined: - Allow - Deny - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available in the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 description: Updates an existing app policy. name: sophos-firewall-app-policy-update outputs: - contextPath: SophosFirewall.ApplicationFilterPolicy.Name description: Name of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.Description description: Description of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.MicroAppSupport description: Whether the policy supports microapps. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.DefaultAction description: Default action the policy executes. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.RuleList.Rule description: Details of the rule. type: String - arguments: - description: Name of the policy. name: name required: true description: Deletes an existing app policy. name: sophos-firewall-app-policy-delete outputs: - contextPath: SophosFirewall.ApplicationFilterPolicy.Name description: Name of the firewall app policy. type: String - contextPath: SophosFirewall.ApplicationFilterPolicy.IsDeleted description: Whether the firewall app policy is deleted. type: Bool - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all app filter categories. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-app-category-list outputs: - contextPath: SophosFirewall.ApplicationFilterCategory.Name description: Name of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.Description description: Description of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.QoSPolicy description: QoS policy of the category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.BandwidthUsageType description: Bandwidth usage type of the category. type: String - arguments: - description: Name of the app category. name: name required: true description: Gets a single app filter category by name. name: sophos-firewall-app-category-get outputs: - contextPath: SophosFirewall.ApplicationFilterCategory.Name description: Name of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.Description description: Description of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.QoSPolicy description: QoS policy of the category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.BandwidthUsageType description: Bandwidth usage type of the category. type: String - arguments: - description: Name of the app category. name: name required: true - description: The description of the category. name: description - description: QoS policy of the category. name: qos_policy description: Updates an existing app filter category. name: sophos-firewall-app-category-update outputs: - contextPath: SophosFirewall.ApplicationFilterCategory.Name description: Name of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.Description description: Description of the app category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.QoSPolicy description: QoS policy of the category. type: String - contextPath: SophosFirewall.ApplicationFilterCategory.BandwidthUsageType description: Bandwidth usage type of the category. type: String - arguments: - defaultValue: '0' description: 'The start index for the rules to list, e.g: 5. Default is "0".' name: start - defaultValue: '50' description: 'The end index for the rules to list, e.g: 20. Default is "50".' name: end description: 'Lists all web filter policies. IMPORTANT: The list starts at 0 (not 1)!' name: sophos-firewall-web-filter-list outputs: - contextPath: SophosFirewall.WebFilterPolicy.Name description: Name of the policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.DefaultAction description: Default action for the web filter policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.WebFilterPolicy.EnableReporting description: Whether the policy reports events. type: String - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestriction description: Maximum file size that can be downloaded. type: Number - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestrictionEnabled description: Whether the file size restriction is active. type: String - contextPath: SophosFirewall.WebFilterPolicy.RuleList.Rule description: Rule list information. type: String - arguments: - description: Name of the policy. name: name required: true description: Gets a single web filter policy by name. name: sophos-firewall-web-filter-get outputs: - contextPath: SophosFirewall.WebFilterPolicy.Name description: Name of the policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.DefaultAction description: Default action for the web filter policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.WebFilterPolicy.EnableReporting description: Whether the policy reports events. type: String - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestriction description: Maximum file size that can be downloaded. type: Number - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestrictionEnabled description: Whether the file size restriction is active. type: String - contextPath: SophosFirewall.WebFilterPolicy.RuleList.Rule description: Rule list information. type: String - arguments: - description: Name of the policy. name: name required: true - description: Description of the policy. name: description - auto: PREDEFINED description: 'Default action for the policy. Possible values: "Allow" and "Deny".' name: default_action predefined: - Allow - Deny required: true - auto: PREDEFINED description: 'Whether the max download file size is enabled. Possible values: "0" and "1".' name: download_file_size_restriction_enabled predefined: - '0' - '1' - description: Maximum file size to enable downloading in MB. name: download_file_size_restriction - auto: PREDEFINED description: 'Enable to specify domains allowed to access the Google service. Possible values: "0" and "1".' name: goog_app_domain_list_enabled predefined: - '0' - '1' - description: The domains allowed to access the Google service. name: goog_app_domain_list - auto: PREDEFINED description: 'Whether to enable YouTube Restricted Mode to restrict the content that is accessible. Possible values: "0" and "1".' name: youtube_filter_enabled predefined: - '0' - '1' - auto: PREDEFINED description: 'Whether to adjust the policy used for YouTube Restricted Mode. Possible values: "0" and "1".' name: youtube_filter_is_strict predefined: - '0' - '1' - auto: PREDEFINED description: 'Enable to block websites containing pornography and explicit sexual content from appearing in the search results of Google, Yahoo, and Bing search results. Possible values: "0" and "1".' name: enforce_safe_search predefined: - '0' - '1' - auto: PREDEFINED description: 'Whether to further limit inappropriate content by enforcing search engine filters for Creative Commons licensed images. Possible values: "0" and "1".' name: enforce_image_licensing predefined: - '0' - '1' - description: Comma-separted list of URL groups to block, allow, warn, or log. name: url_group_names - auto: PREDEFINED description: 'The HTTP action. Possible values: "Deny", "Allow", "Warn", and "Log".' name: http_action predefined: - Deny - Allow - Warn - Log - auto: PREDEFINED description: 'The HTTPs action. Possible values: "Deny", "Allow", "Warn", and "Log".' name: https_action predefined: - Deny - Allow - Warn - Log - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available in the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 - auto: PREDEFINED description: 'Whether to enable the policy rule. Possible values: "1" and "0".' name: policy_rule_enabled predefined: - '1' - '0' - description: A comma-separated list of users who this rule will apply to. name: user_names - description: 'A comma-separated list of CCL names. This argument is required When ccl_rule_enabled is ON.' name: ccl_names - auto: PREDEFINED description: 'Whether to enable the CCL rule. Possible values: "0" and "1". If enabled, ccl_name is required.' name: ccl_rule_enabled predefined: - '1' - '0' - auto: PREDEFINED description: 'Whether to enable the HTTP action. Possible values: "0" and "1".' name: follow_http_action predefined: - '1' - '0' - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable reporting of the policy. Possible values: "Enable" and "Disable". Default is "Enable".' name: enable_reporting predefined: - Enable - Disable description: Adds a new web filter policy. name: sophos-firewall-web-filter-add outputs: - contextPath: SophosFirewall.WebFilterPolicy.Name description: Name of the policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.DefaultAction description: Default action for the web filter policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.WebFilterPolicy.EnableReporting description: Whether the policy reports events. type: String - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestriction description: Maximum file size that can be downloaded. type: Number - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestrictionEnabled description: Whether the file size restriction is active. type: String - contextPath: SophosFirewall.WebFilterPolicy.RuleList.Rule description: Rule list information. type: String - arguments: - description: Name of the policy. name: name required: true - description: Description of the policy. name: description - auto: PREDEFINED description: 'Default action for the policy. Possible values: "Allow" and "Deny".' name: default_action predefined: - Allow - Deny required: true - auto: PREDEFINED description: 'Whether the maximum download file size is enabled. Possible values: "0" and "1".' name: download_file_size_restriction_enabled predefined: - '0' - '1' - description: The maximum file size to enable downloading in MB. name: download_file_size_restriction - auto: PREDEFINED description: 'Whether to enable specifying domains allowed to access the Google service. Possible values: "0" and "1".' name: goog_app_domain_list_enabled predefined: - '0' - '1' - description: Comma-separated list of domains allowed to access the Google service. name: goog_app_domain_list - auto: PREDEFINED description: 'Whether to enable YouTube Restricted Mode to restrict the content that is accessible. Possible values: "0" and "1".' name: youtube_filter_enabled predefined: - '0' - '1' - auto: PREDEFINED description: 'Whether to adjust the policy used for YouTube Restricted Mode. Possible values: "0" and "1".' name: youtube_filter_is_strict predefined: - '0' - '1' - auto: PREDEFINED description: 'Whether to enable blocking websites containing pornography and explicit sexual content from appearing in the search results of Google, Yahoo, and Bing search results. Possible values: "0" and "1".' name: enforce_safe_search predefined: - '0' - '1' - auto: PREDEFINED description: 'Whether to further limit inappropriate content by enforcing search engine filters for Creative Commons licensed images. Possible values: "0" and "1".' name: enforce_image_licensing predefined: - '0' - '1' - description: Comma-separated list of URL groups to block, allow, warn, or log. name: url_group_names - auto: PREDEFINED description: 'The HTTP action. Possible values: "Deny", "Allow", "Warn", and "Log".' name: http_action predefined: - Deny - Allow - Warn - Log - auto: PREDEFINED description: 'The HTTPs action. Possible values: "Deny", "Allow", "Warn", and "Log".' name: https_action predefined: - Deny - Allow - Warn - Log - auto: PREDEFINED description: 'The schedule for the rule. Possible values: "All the time", "Work hours (5 Day week)", "Work hours (6 Day week)", "All Time on Weekdays", "All Time on Weekends", "All Time on Sunday", "All Days 10:00 to 19:00". IMPORTANT: Creating a new schedule is available in the web console.' name: schedule predefined: - All the time - Work hours (5 Day week) - Work hours (6 Day week) - All Time on Weekdays - All Time on Weekends - All Time on Sunday - All Days 10:00 to 19:00 - auto: PREDEFINED description: 'Whether to enable the policy rule. Possible values: "1" and "0".' name: policy_rule_enabled predefined: - '1' - '0' - description: A comma-separated list of users who this rule will apply to. name: user_names - description: 'A comma-separated list of CCL names. REQUIRED: when ccl_rule_enabled is ON.' name: ccl_names - auto: PREDEFINED description: 'Whether to enable the CCL rule. Possible values: "0" and "1". IMPORTANT: If enabled, ccl_name is required.' name: ccl_rule_enabled predefined: - '1' - '0' - auto: PREDEFINED description: 'Whether to enable the HTTP action. Possible values: "0" and "1".' name: follow_http_action predefined: - '1' - '0' - auto: PREDEFINED defaultValue: Enable description: 'Whether to enable reporting of the policy. Possible values: "Enable" and "Disable". Default is "Enable".' name: enable_reporting predefined: - Enable - Disable description: Updates an existing web filter policy. name: sophos-firewall-web-filter-update outputs: - contextPath: SophosFirewall.WebFilterPolicy.Name description: Name of the policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.DefaultAction description: Default action for the web filter policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.Description description: Description of the rule. type: String - contextPath: SophosFirewall.WebFilterPolicy.EnableReporting description: Whether the policy reports events. type: String - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestriction description: Maximum file size that can be downloaded. type: Number - contextPath: SophosFirewall.WebFilterPolicy.DownloadFileSizeRestrictionEnabled description: Whether the file size restriction is active. type: String - contextPath: SophosFirewall.WebFilterPolicy.RuleList.Rule description: Rule list information. type: String - arguments: - description: Name of the policy. name: name required: true description: Deletes an existing web filter policy. name: sophos-firewall-web-filter-delete outputs: - contextPath: SophosFirewall.WebFilterPolicy.Name description: Name of the policy. type: String - contextPath: SophosFirewall.WebFilterPolicy.IsDeleted description: Whether the policy is deleted. type: Bool dockerimage: demisto/python3:3.12.13.10116658 runonce: false script: '-' subtype: python3 type: python tests: - No tests fromversion: 5.0.0