Cloud Perimeter Scan Parameters

action={create|update}

(Required) Specify "create" to configure a new cloud perimeter scan job. Specify "update" to make changes to an existing scan job.

id={value}

(Required and only applicable for Update request) The ID of the scan schedule you want to update.

module={vm|pc}

(Required for Create request) Specify "vm" for a vulnerability scan and "pc" for a compliance scan.

cloud_provider={value}  

(Optional) Specify "azure" for an Azure scan. Specify "aws" for an AWS EC2 scan. The cloud_provider value cannot be changed during an update request.

When cloud_provider=azure, the following parameters cannot be specified in the same request: platform_type, region_code, vpc_id, include_micro_nano_instances, include_lb_from_connector. These parameters only apply when cloud_provider=aws is specified.

cloud_service={value}

(Optional) Specify "vm" (Azure virtual machine) for an Azure scan. Specify "ec2" for an AWS EC2 scan. The cloud_service value cannot be changed during an update request.

connector_name={value}

(Optional) The name of the connector to be used.

One of these parameters must be specified in the request: conector_name or connector_uuid. These are mutually exclusive and cannot be specified in the same request.

connector_uuid={value}

(Optional) The ID of the connector to be used.

One of these parameters must be specified in the request: conector_name or connector_uuid. These are mutually exclusive and cannot be specified in the same request.

scan_title={value}

(Optional) The scan title. When not specified the default scan title is "AWS EC2 Perimeter Scan <date>"

active={0|1}

(Required for Create request) Specify "1" to create an active schedule. Specify "0" to create an inactive schedule.

option_title={value}

(Optional) The title of the option profile to be used.

One of these parameters must be specified in the request: option_title or option_id. These are mutually exclusive and cannot be specified in the same request.

option_id={value}

(Optional) The ID of the option profile to be used.

One of these parameters must be specified in a request: option_title or option_id. These are mutually exclusive and cannot be specified in the same request.

priority={value}

(Optional) Specify a value of 0 - 9 to set a processing priority level for the scan. When not specified, a value of 0 (no priority) is used. Valid values are:

0 = No Priority (the default)

1 = Emergency

2 = Ultimate

3 = Critical

4 = Major

5 = High

6 = Standard

7 = Medium

8 = Minor

9 = Low

iscanner_id={value}

(Optional, only valid when your account is configured to allow internal scanners) The IDs of the scanner appliances to be used. Specify "0" for external scanners. Multiple entries are comma separated.

These parameters cannot be specified in the same request: iscanner_id and iscanner_name.

iscanner_name={value}

(Optional, only valid when your account is configured to allow internal scanners) The friendly names of the scanner appliances to be used or "External" for external scanners. Multiple entries are comma separated.

These parameters cannot be specified in the same request: iscanner_id and iscanner_name.

platform_type={value}

(Optional) The platform type. Valid values are: classic, vpc_peered or selected_vpc.

region_code={value}

(Optional) The EC2 region code. Valid values are:
ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-east-1, eu-west-1, eu-north-1, asa-east-1, us-east-1, us-west-1, us-west-2,  me-south-1, eu-south-1, and af-south-1

One of these parameters must be specified in the request: region_code or vpc_id. These are mutually exclusive and cannot be specified in the same request.

vpc_id={value}

(Optional) The ID of the Virtual Private Cloud (VPC) zone. The ID value must start with vpc-*. We will check if the specified vpc_id exists for the selected connector.

One of these parameters must be specified in the request: region_code or vpc_id. These are mutually exclusive and cannot be specified in the same request.

include_micro_nano_instances={0|1}

(Optional) Specify 1 to include EC2 assets with instance types t2.nano, t3.nano, t1.micro and m1.small in the scan job. By default, this parameter value is set to 0. Note that these instance types must be activated for your account so that we can include them in the scan.

Warning

AWS EC2 assets with instance types t2.nano, t3.nano, t1.micro and m1.small have very limited CPU. When scanning these instance types we recommend you choose an option profile with Light port scanning and no authentication. Alternatively, use Qualys Cloud Agent to perform the equivalent of authenticated scanning for the least performance impact for these instance types.

tag_include_selector={all|any}

(Optional) Select “any” (the default) to include hosts that match at least one of the selected tags. Select “all” to include hosts that match all of the selected tags.

tag_exclude_selector={all|any}

(Optional) Select “any” (the default) to exclude hosts that match at least one of the selected tags. Select “all” to exclude hosts that match all of the selected tags.

tag_set_by={id|name}

(Optional) Specify “id” (the default) to select a tag set by providing tag IDs. Specify “name” to select a tag set by providing tag names. We will check if the tag ids or tag names are valid.

tag_set_include={value}

(Optional) Specify a tag set to include. Hosts that match these tags will be included. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

tag_set_exclude={value}

(Optional) Specify a tag set to exclude. Hosts that match these tags will be excluded. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

include_lb_from_connector={0|1}

(Optional) Specify 1 to include public load balancers from the selected connector in the scan job. By default, this parameter value is set to 0.

Note

When you set this parameter to 1, we fetch public load balancers from the AWS connector in CloudView that has the same configuration as that of the selected connector. If you select this option, ensure that you have the connector created in your CloudView account with a configuration similar to that of the selected connector. If the connector in CloudView is not found, then we can't fetch the public load balancers from the connector.

elb_dns={value}

(Optional) One or more load balancer DNS names to include in the scan job. Multiple values are comma-separated.

schedule={value}

(Required for Create request) Specify "now" to schedule the scan job for now. Specify "recurring" to schedule the scan job to start at a later time or on a recurring basis. See Scheduling Parameters in the next section.