vdiscoverytask : Discovery task object.

This object represents vDiscovery Task.

Object Reference

References to vdiscoverytask are object references.

The name part of a vDiscovery Task object reference has the following components:

  • The name of the Task.

Example: vdiscoverytask/ZG5zLmNkaXNjb3ZlcnlfdGFzayR0YXNrMTA:task10

Restrictions

The object does not support the following operations:

  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name, state.

The following fields are required to create this object:

Field Notes
auto_consolidate_cloud_ea  
auto_consolidate_managed_tenant  
auto_consolidate_managed_vm  
auto_create_dns_hostname_template See the field description for more information
auto_create_dns_record_type See the field description for more information
dns_view_private_ip See the field description for more information
dns_view_public_ip See the field description for more information
domain_name See the field description for more information
driver_type  
identity_version The field is required when driver_type is OPENSTACK.
member  
merge_data  
name  
password The field is required when credentials_type is DIRECT.
private_network_view_mapping_policy  
public_network_view_mapping_policy  
update_metadata  
use_identity See the field description for more information
username The field is required when credentials_type is DIRECT.

allow_unsecured_connection

allow_unsecured_connection

Allow unsecured connection over HTTPS and bypass validation of the remote SSL certificate.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

auto_consolidate_cloud_ea

auto_consolidate_cloud_ea

Whether to insert or update cloud EAs with discovery data.

Type

Bool.

Create

The field is required on creation.

Search

The field is not available for search.

auto_consolidate_managed_tenant

auto_consolidate_managed_tenant

Whether to replace managed tenant with discovery tenant data.

Type

Bool.

Create

The field is required on creation.

Search

The field is not available for search.

auto_consolidate_managed_vm

auto_consolidate_managed_vm

Whether to replace managed virtual machine with discovery vm data.

Type

Bool.

Create

The field is required on creation.

Search

The field is not available for search.

auto_create_dns_hostname_template

auto_create_dns_hostname_template

Template string used to generate host name.

Type

String.

Create

The field is required when auto_create_dns_record is set.

Search

The field is not available for search.

auto_create_dns_record

auto_create_dns_record

Control whether to create or update DNS record using discovered data.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

auto_create_dns_record_type

auto_create_dns_record_type

Indicates the type of record to create if the auto create DNS record is enabled.

Type

String.

Valid values are:
  • A_PTR_RECORD
  • HOST_RECORD

Create

The field is required when auto_create_dns_record is set.

Search

The field is not available for search.

comment

comment

Comment on the task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is not available for search.

credentials_type

credentials_type

Credentials type used for connecting to the cloud management platform.

Type

String.

Valid values are:
  • DIRECT
  • INDIRECT

Create

The default value is undefined.

Search

The field is not available for search.

dns_view_private_ip

dns_view_private_ip

The DNS view name for private IPs.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

If you configure this option, you must also set update_dns_view_private_ip to True. Otherwise, set update_dns_view_private_ip to False.

Search

The field is available for search via

  • ‘=’ (exact equality)

dns_view_public_ip

dns_view_public_ip

The DNS view name for public IPs.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

If you configure this option, you must also set update_dns_view_public_ip to True. Otherwise, set update_dns_view_public_ip to False.

Search

The field is available for search via

  • ‘=’ (exact equality)

domain_name

domain_name

The name of the domain to use with keystone v3.

Type

String.

Create

The field is required when identity_version is KEYSTONE_V3.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

driver_type

driver_type

Type of discovery driver.

Type

String.

Valid values are:
  • AWS
  • AZURE
  • GCP
  • OPENSTACK
  • VMWARE

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

enabled

enabled

Whether to enabled the cloud discovery or not.

Type

Bool.

Create

The default value is True.

Search

The field is available for search via

  • ‘=’ (exact equality)

fqdn_or_ip

fqdn_or_ip

FQDN or IP of the cloud management platform.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

identity_version

identity_version

Identity service version.

Type

String.

Valid values are:
  • KEYSTONE_V2
  • KEYSTONE_V3

Create

The field is required when driver_type is OPENSTACK.

Search

The field is available for search via

  • ‘=’ (exact equality)

last_run

last_run

Timestamp of last run.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_run cannot be updated.

last_run cannot be written.

member

member

Member on which cloud discovery will be run.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

merge_data

merge_data

Whether to replace the old data with new or not.

Type

Bool.

Create

The field is required on creation.

Search

The field is not available for search.

name

name

Name of this cloud discovery task. Uniquely identify a task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

password

password

Password used for connecting to the cloud management platform.

Type

String.

Create

The field is required when credentials_type is DIRECT.

Search

The field is not available for search.

Notes

password is not readable.

port

port

Connection port used for connecting to the cloud management platform.

Type

Unsigned integer.

Create

The default value is 443.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

private_network_view

private_network_view

Network view for private IPs.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

private_network_view_mapping_policy

private_network_view_mapping_policy

Mapping policy for the network view for private IPs in discovery data.

Type

String.

Valid values are:
  • AUTO_CREATE
  • DIRECT

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

protocol

protocol

Connection protocol used for connecting to the cloud management platform.

Type

String.

Valid values are:
  • HTTP
  • HTTPS

Create

The default value is HTTPS.

Search

The field is available for search via

  • ‘=’ (exact equality)

public_network_view

public_network_view

Network view for public IPs.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

public_network_view_mapping_policy

public_network_view_mapping_policy

Mapping policy for the network view for public IPs in discovery data.

Type

String.

Valid values are:
  • AUTO_CREATE
  • DIRECT

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

scheduled_run

scheduled_run

Schedule setting for cloud discovery task.

Type

A/An Schedule Setting struct.

Create

The default value is undefined.

Search

The field is not available for search.

service_account_file

service_account_file

The service_account_file for GCP.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

state

state

Current state of this task.

Type

String.

Valid values are:
  • CANCEL_PENDING
  • COLLECTION_COMPLETE
  • COMPLETE
  • ERROR
  • IDLE
  • READY
  • RUNNING
  • WARNING

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The state is part of the base object.

The state cannot be updated.

state cannot be written.

state_msg

state_msg

State message of the complete discovery process.

Type

String.

Search

The field is not available for search.

Notes

The state_msg cannot be updated.

state_msg cannot be written.

update_dns_view_private_ip

update_dns_view_private_ip

If set to true, the appliance uses a specific DNS view for private IPs.

Type

Bool.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

update_dns_view_public_ip

update_dns_view_public_ip

If set to true, the appliance uses a specific DNS view for public IPs.

Type

Bool.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

update_metadata

update_metadata

Whether to update metadata as a result of this network discovery.

Type

Bool.

Create

The field is required on creation.

Search

The field is not available for search.

use_identity

use_identity

If set true, all keystone connection will use “/identity” endpoint and port value will be ignored.

Type

Bool.

Create

The field is required when driver_type is OPENSTACK. The default value is False

Search

The field is available for search via

  • ‘=’ (exact equality)

username

username

Username used for connecting to the cloud management platform.

Type

String.

Create

The field is required when credentials_type is DIRECT.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Function Calls

vdiscovery_control

This function provides the following control to a cloud discovery task : start a task and cancel a task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

action ( String. Valid values are: “START”, “CANCEL” ) Action being requested.

Output fields

None

Fields List

Field Type Req R/O Base Search
allow_unsecured_connection Bool N N N N/A
auto_consolidate_cloud_ea Bool Y N N N/A
auto_consolidate_managed_tenant Bool Y N N N/A
auto_consolidate_managed_vm Bool Y N N N/A
auto_create_dns_hostname_template String Y* N N N/A
auto_create_dns_record Bool N N N N/A
auto_create_dns_record_type String Y* N N N/A
comment String N N N N/A
credentials_type String N N N N/A
dns_view_private_ip String Y* N N =
dns_view_public_ip String Y* N N =
domain_name String Y* N N : = ~
driver_type String Y N N =
enabled Bool N N N =
fqdn_or_ip String Y* N N : = ~
identity_version String Y* N N =
last_run Timestamp N Y N N/A
member String Y N N =
merge_data Bool Y N N N/A
name String Y N Y : = ~
password String Y* N N N/A
port Unsigned int N N N ! < = >
private_network_view String N N N =
private_network_view_mapping_policy String Y N N =
protocol String N N N =
public_network_view String N N N =
public_network_view_mapping_policy String Y N N =
scheduled_run struct N N N N/A
service_account_file String Y* N N : = ~
state String N Y Y =
state_msg String N Y N N/A
update_dns_view_private_ip Bool N N N =
update_dns_view_public_ip Bool N N N =
update_metadata Bool Y N N N/A
use_identity Bool Y* N N =
username String Y* N N : = ~

* Required in some cases, see detailed field description above.