diff --git a/README.md b/README.md index 8bdb88e..9506fe8 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,8 @@ VARIABLE | REQUIRED | TYPE | DESCRIPTION [remove group user](#action-remove-group-user) - Remove user from group [create destination group](#action-create-destination-group) - Create destination group [list destination group](#action-list-destination-group) - List destination group +[edit destination group](#action-edit-destination-group) - Edit destination group +[delete destination group](#action-delete-destination-group) - Delete destination group ## action: 'test connectivity' Validate the asset configuration for connectivity using supplied configuration @@ -771,6 +773,7 @@ DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES action_result.status | string | | test success test failed action_result.parameter.countries | string | | action_result.parameter.ip_categories | string | | +action_result.parameter.description | string | | action_result.parameter.addresses | string | | action_result.parameter.type | string | | action_result.parameter.name | string | | @@ -797,9 +800,9 @@ Read only: **False** #### Action Parameters PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS --------- | -------- | ----------- | ---- | -------- -**ip_group_id** | optional | A comma-separated list of unique identifiers for the IP destination groups | string | +**ip_group_ids** | optional | A comma-separated list of unique identifiers for the IP destination groups | string | **exclude_type** | optional | The IP group type to be excluded from the results | string | -**category_type** | optional | The IP group type to be filtered from results. This argument is only supported when the 'lite' argument is set to True | string | +**category_type** | optional | Comma seperated list of IP group types to be filtered from results. This argument is only supported when the 'lite' argument is set to True | string | **include_ipv6** | optional | Retrieve IPv6 destination groups | boolean | **limit** | optional | Limit of the results to be retrieved | numeric | **all_results** | optional | Whether to retrieve all results at once | boolean | @@ -828,4 +831,71 @@ action_result.summary.message | string | | Retreived Destination Groups action_result.message | string | | Retreived Destination Groups summary.message | string | | summary.total_objects | numeric | | 1 +summary.total_objects_successful | numeric | | 1 + +## action: 'edit destination group' +Edit destination group + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**ip_group_id** | required | The unique identifier for the IP destination group | numeric | +**name** | optional | Destination IP group name | string | +**addresses** | optional | Comma seperated string of destination IP addresses, FQDNs, or wildcard FQDNs added to the group | string | +**description** | optional | Additional information about the destination IP group. | string | +**ip_categories** | optional | Destination IP address URL categories | string | +**countries** | optional | Destination IP address countries. You can identify destinations based on the location of a server. | string | +**is_non_editable** | optional | If set to true, the destination IP address group is non-editable. This field is applicable only to predefined IP address groups, which cannot be modified | boolean | + +#### Action Output +DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES +--------- | ---- | -------- | -------------- +action_result.status | string | | test success test failed +action_result.parameter.is_non_editable | boolean | | +action_result.parameter.countries | string | | +action_result.parameter.ip_categories | string | | +action_result.parameter.description | string | | +action_result.parameter.addresses | string | | +action_result.parameter.name | string | | +action_result.parameter.ip_group_id | numeric | | +action_result.data.\*.id | numeric | | +action_result.data.\*.name | string | | +action_result.data.\*.type | string | | DSTN_IP DSTN_FQDN DSTN_DOMAIN DSTN_OTHER +action_result.data.\*.addresses | string | | 192.168.1.1 +action_result.data.\*.countries | string | | +action_result.data.\*.description | string | | +action_result.data.\*.ipCategories | string | | TRADING_BROKARAGE_INSURANCE +action_result.data.\*.creatorContext | string | | +action_result.summary | string | | +action_result.summary.message | string | | test User removed from group +action_result.message | string | | test User removed from group +summary.message | string | | +summary.total_objects | numeric | | 1 +summary.total_objects_successful | numeric | | 1 + +## action: 'delete destination group' +Delete destination group + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**ip_group_ids** | optional | A comma-separated list of unique identifiers for the IP destination groups | string | + +#### Action Output +DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES +--------- | ---- | -------- | -------------- +action_result.status | string | | test success test failed +action_result.parameter.ip_group_ids | string | | +action_result.data.\*.ip_group_ids | string | | +action_result.summary | string | | +action_result.summary.message | string | | test User removed from group +action_result.message | string | | test User removed from group +summary.message | string | | +summary.total_objects | numeric | | 1 summary.total_objects_successful | numeric | | 1 \ No newline at end of file