gcpdnstaskgroup : Gcp DNS task group object.¶
An Gcp DNS task group is a collection of one or more tasks allowing you to specify various zone filters to retrieve DNS zone data from Gcp DNS service using specified Gcp user credentials. Grouping these tasks together helps organize related groups of sync data, enable/disable these and manage the grid member these run on.
Object Reference¶
References to gcpdnstaskgroup are object references.
The name part of the name server group object reference has the following components:
Name of the Gcp DNS task group
Example: gcpdnstaskgroup/ZG5zLmJpbmRfY25h:extdatagroup
Restrictions¶
The object does not support the following operations:
Scheduling
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): comment, disabled, name, project_id, sync_child_projects, sync_status.
The following fields are required to create this object:
Field |
Notes |
|---|---|
consolidated_view |
See the field description for more information |
gcp_project_ids_file_token |
See the field description for more information |
grid_member |
|
name |
|
network_view |
See the field description for more information |
comment¶
- comment¶
Comment for the task group; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The comment is part of the base object.
consolidate_zones¶
- consolidate_zones¶
Indicates if all zones need to be saved into a single view.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The consolidate_zones cannot be updated.
consolidated_view¶
- consolidated_view¶
Consolidate all zones into one view.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The consolidated view is required if consolidate_zones is set and network_view_mapping_policy is DIRECT
Search
The field is available for search via
‘=’ (exact equality)
Notes
The consolidated_view cannot be updated.
disabled¶
- disabled¶
Indicates if the task group is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The disabled is part of the base object.
gcp_project_ids_file_token¶
- gcp_project_ids_file_token¶
The Gcp project IDs file’s token.
Type
String.
Create
The gcp_project_ids_file_token is required if multiple_projects_sync_policy is set to UPLOAD_PROJECTS
Search
The field is available for search via
‘=’ (exact equality)
grid_member¶
- grid_member¶
Grid member configured to run this task group.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
multiple_projects_sync_policy¶
- multiple_projects_sync_policy¶
Discover all child projects or Upload child project ids to discover.
Type
String.
- Valid values are:
DISCOVER_PROJECTS
NONE
UPLOAD_PROJECTS
Create
The default value is NONE.
Search
The field is available for search via
‘=’ (exact equality)
name¶
- name¶
The name of this Gcp DNS sync task group.
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
network_view¶
- network_view¶
The name of the tenant’s network view.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The network view required if network_view_mapping_policy is set to DIRECT
Search
The field is available for search via
‘=’ (exact equality)
Notes
The network_view cannot be updated.
network_view_mapping_policy¶
- network_view_mapping_policy¶
The network view mapping policy.
Type
String.
- Valid values are:
AUTO_CREATE
DIRECT
Create
The default value is AUTO_CREATE.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The network_view_mapping_policy cannot be updated.
project_id¶
- project_id¶
The Gcp project ID associated with this task group.
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The project_id is part of the base object.
The project_id cannot be updated.
project_id cannot be written.
projects_list¶
- projects_list¶
The Gcp Project IDs list associated with this task.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The projects_list cannot be updated.
projects_list cannot be written.
sync_child_projects¶
- sync_child_projects¶
Synchronizing child projects is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The sync_child_projects is part of the base object.
sync_status¶
- sync_status¶
Sync status for this task.
Type
String.
- Valid values are:
NOT_SYNCING
OFFLINE
OK
SYNC_ERROR
Search
The field is available for search via
‘=’ (exact equality)
Notes
The sync_status is part of the base object.
The sync_status cannot be updated.
sync_status cannot be written.
task_list¶
- task_list¶
List of Gcp DNS tasks in this group.
Type
A/An Gcp DNS task struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Function Calls¶
task_control¶
This function performs action on a task. Current support is for RUN action.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
action ( String. Valid values are: “RUN” ). This parameter is mandatory. The task control action to perform. Currently only start is supported.
cloud_dns_server_type ( String. Valid values are: “AWS”, “Azure”, “GCP” ). This parameter is mandatory. This field contains the name of the cloud provider.
task_name ( String. ). This parameter is mandatory. This field contains the name of the task to perform this action on.
Output fields
None
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
comment |
String |
N |
N |
Y |
: = ~ |
consolidate_zones |
Bool |
N |
N |
N |
= |
consolidated_view |
String |
Y* |
N |
N |
= |
disabled |
Bool |
N |
N |
Y |
= |
gcp_project_ids_file_token |
String |
Y* |
N |
N |
= |
grid_member |
String |
Y |
N |
N |
= |
multiple_projects_sync_policy |
String |
N |
N |
N |
= |
name |
String |
Y |
N |
Y |
: = ~ |
network_view |
String |
Y* |
N |
N |
= |
network_view_mapping_policy |
String |
N |
N |
N |
= |
project_id |
String |
N |
Y |
Y |
: = ~ |
projects_list |
String |
N |
Y |
N |
= |
sync_child_projects |
Bool |
N |
N |
Y |
= |
sync_status |
String |
N |
Y |
Y |
= |
task_list |
[struct] |
N |
N |
N |
N/A |
* Required in some cases, see detailed field description above.
