Skip to main content

Google Cloud Platform

This Integration is part of the GCP Pack.#

Supported versions

Available on Cortex XSOAR (versions 8.11.0 and later) and Cortex XSIAM.

The GCP Integration automates management and security configurations for Compute Engine, Storage, and Container resources on GCP. This integration was integrated and tested with version v1 (Compute, Storage, Container, SERVICE_USAGE), v3 (Resource Manager).

Configure Google Cloud Platform in Cortex#

ParameterDescriptionRequired
Service Account Private Key (JSON)The full content of a GCP Service Account private key JSON file. In the Google Cloud Console, go to IAM & Admin > Service Accounts and create a service account with the required roles. Then under the Keys tab, create a JSON key. Paste the downloaded JSON contents here.True
GCP Project IDThe GCP project ID to authenticate against when testing the integration (e.g. my-project-123). If left empty, the project ID from the Service Account private key JSON is used.False
Use system proxy settingsFalse
Trust any certificate (not secure)False

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

gcp-compute-firewall-patch#


Updates a specific firewall rule with the data included in the request. Required permissions: compute.firewalls.update, compute.firewalls.get, compute.firewalls.list, compute.networks.updatePolicy, compute.networks.list.

Base Command#

gcp-compute-firewall-patch

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameName of the firewall rule to update.Required
descriptionAn optional description of this resource, which you provide when you create the resource.Optional
networkURL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used.Optional
priorityPriority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules.Optional
sourceRangesIf source ranges are specified, the firewall applies only to traffic with source IP addresses in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall applies to traffic with a source IP address within sourceRanges OR the source IP belonging to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported, comma-separated.Optional
destinationRangesIf destination ranges are specified, the firewall applies only to traffic with destination IP addresses in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. Comma-separated.Optional
sourceTagsIf source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address. It only applies to traffic between instances in the same virtual network, because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic with a source IP address within sourceRanges OR the source IP belonging to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Comma-separated.Optional
targetTagsA list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. Comma-separated.Optional
sourceServiceAccountsIf source service accounts are specified, the firewall applies only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has a source IP address within sourceRanges OR the source IP belongs to an instance with a service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used simultaneously as sourceTags or targetTags. Comma-separated.Optional
targetServiceAccountsA list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. Comma-separated.Optional
allowedThe ALLOW rules list specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. For example, ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.Optional
deniedThe DENY rules list specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. For example, ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.Optional
directionDirection of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.Optional
logConfigEnableThis field denotes whether to enable logging for a particular firewall rule. Possible values are: true, false.Optional
disabledDenotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-storage-bucket-policy-delete#


Removes an entity from a bucket's Access Control List. Required permissions: storage.buckets.getIamPolicy, storage.buckets.setIamPolicy.

Base Command#

gcp-storage-bucket-policy-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameName of the GCS bucket.Required
entityEntity to remove from the Access Control List.
Common entity formats are:
user:<userId or email>
group:<groupId or email>
allUsers
allAuthenticatedUsers
For more options and details, see: https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls#resource . Default is allUsers.
Optional

Context Output#

There is no context output for this command.

gcp-compute-subnet-update#


Enables flow logs or Private Google Access on a subnet. Required permissions: compute.subnetworks.setPrivateIpGoogleAccess, compute.subnetworks.update, compute.subnetworks.get, compute.subnetworks.list.

Base Command#

gcp-compute-subnet-update

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionGCP region.Required
resource_nameSubnet name.Required
enable_flow_logsEnable VPC Flow Logs. Possible values are: true, false.Optional
enable_private_ip_google_accessEnable Private Google Access. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.nameStringThe name of the updated subnet.
GCP.Compute.Operations.regionStringThe region of the updated subnet.
GCP.Compute.Operations.subnetNameStringThe name of the subnet that was updated.
GCP.Compute.Operations.enableFlowLogsBooleanWhether flow logs are enabled for the subnet.
GCP.Compute.Operations.ipCidrRangeStringThe updated CIDR range for the subnet.
GCP.Compute.Operations.privateIpGoogleAccessBooleanWhether private Google access is enabled for the subnet.
GCP.Compute.Operations.privateIpv6GoogleAccessBooleanWhether private IPv6 Google access is enabled for the subnet.
GCP.Compute.Operations.stackTypeStringThe stack type of the subnet (e.g., `IPV4`, `IPV6`).
GCP.Compute.Operations.rangeNameStringThe name of the IP range associated with the subnet.
GCP.Compute.Operations.secondaryIpRangesUnknownList of secondary IP ranges for the subnet.
GCP.Compute.Operations.descriptionStringThe description of the subnet.

gcp-container-cluster-security-update#


Configures security settings for GKE clusters, including access controls and visibility. Required permissions: container.clusters.update, container.clusters.get, container.clusters.list.

Base Command#

gcp-container-cluster-security-update

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionGCP region.Required
resource_nameName of the GKE cluster.Required
enable_intra_node_visibilityEnable intra-node visibility. Possible values are: true, false.Optional
enable_master_authorized_networksEnable Master Authorized Networks. Possible values are: true, false.Optional
cidrsComma-separated list of up to 50 CIDR blocks (e.g., "192.168.0.0/24,10.0.0.0/32") that are allowed to access the Kubernetes master via HTTPS.
If enable_master_authorized_networks is true and no CIDRs are provided, all access will be blocked.
.
Optional

Context Output#

PathTypeDescription
GCP.Container.Operations.nameStringThe name of the GKE cluster.
GCP.Container.Operations.zoneStringThe zone of the GKE cluster.
GCP.Container.Operations.enableStackdriverLoggingBooleanWhether Stackdriver Logging is enabled for the cluster.
GCP.Container.Operations.enableStackdriverMonitoringBooleanWhether Stackdriver Monitoring is enabled for the cluster.
GCP.Container.Operations.enablePrivateNodesBooleanWhether private nodes are enabled for the GKE cluster.
GCP.Container.Operations.enablePrivateEndpointBooleanWhether private endpoint is enabled for the GKE cluster control plane.
GCP.Container.Operations.enableHttpsOnlyBooleanWhether HTTPS-only traffic is enforced for the cluster.
GCP.Container.Operations.enableNetworkPolicyBooleanWhether network policies are enabled for the cluster.
GCP.Container.Operations.enableAutoscalingBooleanWhether autoscaling is enabled for the cluster nodes.
GCP.Container.Operations.enableIstioBooleanWhether Istio is enabled for the GKE cluster.
GCP.Container.Operations.enablePodSecurityPolicyBooleanWhether PodSecurityPolicy is enabled for the GKE cluster.
GCP.Container.Operations.enableBinaryAuthorizationBooleanWhether Binary Authorization is enabled for the cluster.
GCP.Container.Operations.enableLegacyABACBooleanWhether legacy ABAC is enabled for the cluster.
GCP.Container.Operations.clusterIpv4CidrStringThe cluster’s IPv4 CIDR block.
GCP.Container.Operations.masterAuthorizedNetworksConfig.cidrBlocksUnknownList of authorized CIDR blocks that can access the GKE cluster master.
GCP.Container.Operations.masterAuthorizedNetworksConfig.enabledBooleanWhether master authorized networks are enabled for the cluster.
GCP.Container.Operations.networkStringThe network to which the GKE cluster belongs.
GCP.Container.Operations.subnetworkStringThe subnetwork to which the GKE cluster belongs.
GCP.Container.Operations.loggingServiceStringThe logging service used for the cluster (e.g., "logging.googleapis.com").
GCP.Container.Operations.monitoringServiceStringThe monitoring service used for the cluster (e.g., "monitoring.googleapis.com").
GCP.Container.Operations.nodePoolsUnknownA list of node pools in the cluster, with their configuration and security settings.
GCP.Container.Operations.privateClusterConfig.enablePrivateNodesBooleanWhether private nodes are enabled in the cluster.
GCP.Container.Operations.privateClusterConfig.enablePrivateEndpointBooleanWhether private endpoint is enabled for the cluster control plane.
GCP.Container.Operations.masterVersionStringThe current version of the Kubernetes master in the GKE cluster.

gcp-gke-cluster-legacy-abac-auth-set#


Enables or disables legacy ABAC authorization for a GKE cluster. Required permissions: container.clusters.update.

Base Command#

gcp-gke-cluster-legacy-abac-auth-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the cluster.Required
resource_nameThe name of the GKE cluster.Required
enabledWhether to enable legacy ABAC authorization on the cluster. Possible values are: true, false.Required

Context Output#

PathTypeDescription
GCP.GKE.Operations.clusterConditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Operations.detailStringDetailed operation progress, if available.
GCP.GKE.Operations.endTimeStringThe time the operation completed, in RFC3339 text format.
GCP.GKE.Operations.errorUnknownThe error result of the operation in case of failure.
GCP.GKE.Operations.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Operations.nameStringThe server-assigned ID for the operation.
GCP.GKE.Operations.nodepoolConditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.Operations.operationTypeStringThe operation type.
GCP.GKE.Operations.progressUnknownProgress information for an operation.
GCP.GKE.Operations.selfLinkStringServer-defined URI for the operation.
GCP.GKE.Operations.startTimeStringThe time the operation started, in RFC3339 text format.
GCP.GKE.Operations.statusStringThe current status of the operation.
GCP.GKE.Operations.statusMessageStringIf an error has occurred, a textual description of the error.
GCP.GKE.Operations.targetLinkStringServer-defined URI for the target of the operation.
GCP.GKE.Operations.zoneStringThe name of the Google Compute Engine zone in which the operation is taking place.

gcp-gke-clusters-list#


Lists all GKE clusters owned by a project in the specified location. Required permissions: container.clusters.list.

Base Command#

gcp-gke-clusters-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) to list clusters from. Use "-" to list clusters from all locations.Required

Context Output#

PathTypeDescription
GCP.GKE.Clusters.addonsConfigUnknownConfigurations for the various addons available to run in the cluster.
GCP.GKE.Clusters.alphaClusterFeatureGatesUnknownThe list of user specified Kubernetes feature gates.
GCP.GKE.Clusters.anonymousAuthenticationConfigUnknownConfiguration for limiting anonymous access to all endpoints except the health checks.
GCP.GKE.Clusters.authenticatorGroupsConfigUnknownConfiguration controlling RBAC group membership information.
GCP.GKE.Clusters.autopilotUnknownAutopilot configuration for the cluster.
GCP.GKE.Clusters.autoscalingUnknownCluster-level autoscaling configuration.
GCP.GKE.Clusters.binaryAuthorizationUnknownConfiguration for Binary Authorization.
GCP.GKE.Clusters.clusterIpv4CidrStringThe IP address range of the container pods in this cluster, in CIDR notation.
GCP.GKE.Clusters.compliancePostureConfigUnknownCompliance posture configuration for the cluster (no longer supported).
GCP.GKE.Clusters.conditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Clusters.confidentialNodesUnknownConfiguration of Confidential Nodes.
GCP.GKE.Clusters.controlPlaneEgressUnknownConfiguration for control plane egress control.
GCP.GKE.Clusters.controlPlaneEndpointsConfigUnknownConfiguration for all cluster's control plane endpoints.
GCP.GKE.Clusters.costManagementConfigUnknownConfiguration for the fine-grained cost management feature.
GCP.GKE.Clusters.createTimeStringThe time the cluster was created, in RFC3339 text format.
GCP.GKE.Clusters.currentEmulatedVersionStringThe current emulated version of the master endpoint.
GCP.GKE.Clusters.currentMasterVersionStringThe current software version of the master endpoint.
GCP.GKE.Clusters.currentNodeCountNumberThe number of nodes currently in the cluster.
GCP.GKE.Clusters.currentNodeVersionStringThe current version of the Kubernetes nodes in the cluster (deprecated; use the node pool version instead).
GCP.GKE.Clusters.databaseEncryptionUnknownConfiguration of etcd encryption.
GCP.GKE.Clusters.defaultMaxPodsConstraintUnknownThe default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster.
GCP.GKE.Clusters.descriptionStringAn optional description of this cluster.
GCP.GKE.Clusters.enableK8sBetaApisUnknownBeta APIs Config.
GCP.GKE.Clusters.enableKubernetesAlphaBooleanKubernetes alpha features are enabled on this cluster.
GCP.GKE.Clusters.enableTpuBooleanEnable the ability to use Cloud TPUs in this cluster.
GCP.GKE.Clusters.endpointStringThe IP address of this cluster's master endpoint.
GCP.GKE.Clusters.enterpriseConfigUnknownGKE Enterprise Configuration.
GCP.GKE.Clusters.etagStringThis checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
GCP.GKE.Clusters.expireTimeStringThe time the cluster will be automatically deleted in RFC3339 text format.
GCP.GKE.Clusters.fleetUnknownFleet information for the cluster.
GCP.GKE.Clusters.gkeAutoUpgradeConfigUnknownConfiguration for GKE auto upgrades.
GCP.GKE.Clusters.idStringUnique id for the cluster.
GCP.GKE.Clusters.identityServiceConfigUnknownConfiguration for Identity Service component.
GCP.GKE.Clusters.initialClusterVersionStringThe initial Kubernetes version for this cluster.
GCP.GKE.Clusters.initialNodeCountNumberThe number of nodes to create in this cluster.
GCP.GKE.Clusters.instanceGroupUrlsUnknownThe instanceGroupUrls of the resource.
GCP.GKE.Clusters.ipAllocationPolicyUnknownConfiguration for cluster IP allocation.
GCP.GKE.Clusters.labelFingerprintStringThe fingerprint of the set of labels for this cluster.
GCP.GKE.Clusters.legacyAbacUnknownConfiguration for the legacy ABAC authorization mode.
GCP.GKE.Clusters.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Clusters.locationsUnknownThe list of Google Compute Engine zones in which the cluster's nodes should be located.
GCP.GKE.Clusters.loggingConfigUnknownLogging configuration for the cluster.
GCP.GKE.Clusters.loggingServiceStringThe logging service the cluster should use to write logs.
GCP.GKE.Clusters.maintenancePolicyUnknownConfigure the maintenance policy for this cluster.
GCP.GKE.Clusters.managedMachineLearningDiagnosticsConfigUnknownConfiguration for Managed Machine Learning Diagnostics.
GCP.GKE.Clusters.managedOpentelemetryConfigUnknownConfiguration for Managed OpenTelemetry pipeline.
GCP.GKE.Clusters.masterAuthUnknownThe authentication information for accessing the master endpoint.
GCP.GKE.Clusters.masterAuthorizedNetworksConfigUnknownThe configuration options for master authorized networks feature.
GCP.GKE.Clusters.meshCertificatesUnknownConfiguration for issuance of mTLS keys and certificates to Kubernetes pods.
GCP.GKE.Clusters.monitoringConfigUnknownMonitoring configuration for the cluster.
GCP.GKE.Clusters.monitoringServiceStringThe monitoring service the cluster should use to write metrics.
GCP.GKE.Clusters.nameStringThe name of this cluster.
GCP.GKE.Clusters.networkStringThe name of the Google Compute Engine network to which the cluster is connected.
GCP.GKE.Clusters.networkConfigUnknownConfiguration for cluster networking.
GCP.GKE.Clusters.networkPolicyUnknownConfiguration options for the NetworkPolicy feature.
GCP.GKE.Clusters.nodeConfigUnknownParameters used in creating the cluster's nodes.
GCP.GKE.Clusters.nodeCreationConfigUnknownConfiguration for Node Creation Mode.
GCP.GKE.Clusters.nodeIpv4CidrSizeNumberThe size of the address space on each node for hosting containers.
GCP.GKE.Clusters.nodePoolAutoConfigUnknownNode pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
GCP.GKE.Clusters.nodePoolDefaultsUnknownDefault NodePool settings for the entire cluster.
GCP.GKE.Clusters.nodePoolsUnknownThe node pools associated with this cluster.
GCP.GKE.Clusters.notificationConfigUnknownNotification configuration of the cluster.
GCP.GKE.Clusters.parentProductConfigUnknownThe configuration of the parent product of the cluster.
GCP.GKE.Clusters.podAutoscalingUnknownThe config for pod autoscaling.
GCP.GKE.Clusters.privateClusterConfigUnknownConfiguration for private cluster.
GCP.GKE.Clusters.rbacBindingConfigUnknownRBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
GCP.GKE.Clusters.releaseChannelUnknownRelease channel configuration.
GCP.GKE.Clusters.resourceLabelsUnknownThe resource labels for the cluster to use to annotate any related Google Compute Engine resources.
GCP.GKE.Clusters.resourceUsageExportConfigUnknownConfiguration for exporting resource usages.
GCP.GKE.Clusters.rollbackSafeUpgradeUnknownThe rollback safe upgrade information of the cluster.
GCP.GKE.Clusters.satisfiesPziBooleanReserved for future use.
GCP.GKE.Clusters.satisfiesPzsBooleanReserved for future use.
GCP.GKE.Clusters.scheduleUpgradeConfigUnknownConfiguration for scheduled upgrades.
GCP.GKE.Clusters.secretManagerConfigUnknownSecret CSI driver configuration.
GCP.GKE.Clusters.secretSyncConfigUnknownConfiguration for sync Secret Manager secrets as k8s secrets.
GCP.GKE.Clusters.securityPostureConfigUnknownEnable/Disable Security Posture API features for the cluster.
GCP.GKE.Clusters.selfLinkStringServer-defined URL for the resource.
GCP.GKE.Clusters.servicesIpv4CidrStringThe IP address range of the Kubernetes services in this cluster, in CIDR notation.
GCP.GKE.Clusters.shieldedNodesUnknownShielded Nodes configuration.
GCP.GKE.Clusters.statusStringThe current status of this cluster.
GCP.GKE.Clusters.statusMessageStringThe statusMessage of the resource.
GCP.GKE.Clusters.subnetworkStringThe name of the Google Compute Engine subnetwork to which the cluster is connected.
GCP.GKE.Clusters.tpuIpv4CidrBlockStringThe IP address range of the Cloud TPUs in this cluster, in CIDR notation.
GCP.GKE.Clusters.userManagedKeysConfigUnknownThe Custom keys configuration for the cluster.
GCP.GKE.Clusters.verticalPodAutoscalingUnknownCluster-level Vertical Pod Autoscaling configuration.
GCP.GKE.Clusters.workloadIdentityConfigUnknownConfiguration for the use of Kubernetes Service Accounts in IAM policies.
GCP.GKE.Clusters.zoneStringThe name of the Google Compute Engine zone in which the cluster resides.

gcp-gke-cluster-get#


Gets the details of a specific GKE cluster. Required permissions: container.clusters.get.

Base Command#

gcp-gke-cluster-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the cluster.Required
resource_nameThe name of the GKE cluster.Required

Context Output#

PathTypeDescription
GCP.GKE.Clusters.addonsConfigUnknownConfigurations for the various addons available to run in the cluster.
GCP.GKE.Clusters.alphaClusterFeatureGatesUnknownThe list of user specified Kubernetes feature gates.
GCP.GKE.Clusters.anonymousAuthenticationConfigUnknownConfiguration for limiting anonymous access to all endpoints except the health checks.
GCP.GKE.Clusters.authenticatorGroupsConfigUnknownConfiguration controlling RBAC group membership information.
GCP.GKE.Clusters.autopilotUnknownAutopilot configuration for the cluster.
GCP.GKE.Clusters.autoscalingUnknownCluster-level autoscaling configuration.
GCP.GKE.Clusters.binaryAuthorizationUnknownConfiguration for Binary Authorization.
GCP.GKE.Clusters.clusterIpv4CidrStringThe IP address range of the container pods in this cluster, in CIDR notation.
GCP.GKE.Clusters.compliancePostureConfigUnknownCompliance posture configuration for the cluster (no longer supported).
GCP.GKE.Clusters.conditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Clusters.confidentialNodesUnknownConfiguration of Confidential Nodes.
GCP.GKE.Clusters.controlPlaneEgressUnknownConfiguration for control plane egress control.
GCP.GKE.Clusters.controlPlaneEndpointsConfigUnknownConfiguration for all cluster's control plane endpoints.
GCP.GKE.Clusters.costManagementConfigUnknownConfiguration for the fine-grained cost management feature.
GCP.GKE.Clusters.createTimeStringThe time the cluster was created, in RFC3339 text format.
GCP.GKE.Clusters.currentEmulatedVersionStringThe current emulated version of the master endpoint.
GCP.GKE.Clusters.currentMasterVersionStringThe current software version of the master endpoint.
GCP.GKE.Clusters.currentNodeCountNumberThe number of nodes currently in the cluster.
GCP.GKE.Clusters.currentNodeVersionStringThe current version of the Kubernetes nodes in the cluster (deprecated; use the node pool version instead).
GCP.GKE.Clusters.databaseEncryptionUnknownConfiguration of etcd encryption.
GCP.GKE.Clusters.defaultMaxPodsConstraintUnknownThe default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster.
GCP.GKE.Clusters.descriptionStringAn optional description of this cluster.
GCP.GKE.Clusters.enableK8sBetaApisUnknownBeta APIs Config.
GCP.GKE.Clusters.enableKubernetesAlphaBooleanKubernetes alpha features are enabled on this cluster.
GCP.GKE.Clusters.enableTpuBooleanEnable the ability to use Cloud TPUs in this cluster.
GCP.GKE.Clusters.endpointStringThe IP address of this cluster's master endpoint.
GCP.GKE.Clusters.enterpriseConfigUnknownGKE Enterprise Configuration.
GCP.GKE.Clusters.etagStringThis checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
GCP.GKE.Clusters.expireTimeStringThe time the cluster will be automatically deleted in RFC3339 text format.
GCP.GKE.Clusters.fleetUnknownFleet information for the cluster.
GCP.GKE.Clusters.gkeAutoUpgradeConfigUnknownConfiguration for GKE auto upgrades.
GCP.GKE.Clusters.idStringUnique id for the cluster.
GCP.GKE.Clusters.identityServiceConfigUnknownConfiguration for Identity Service component.
GCP.GKE.Clusters.initialClusterVersionStringThe initial Kubernetes version for this cluster.
GCP.GKE.Clusters.initialNodeCountNumberThe number of nodes to create in this cluster.
GCP.GKE.Clusters.instanceGroupUrlsUnknownThe instanceGroupUrls of the resource.
GCP.GKE.Clusters.ipAllocationPolicyUnknownConfiguration for cluster IP allocation.
GCP.GKE.Clusters.labelFingerprintStringThe fingerprint of the set of labels for this cluster.
GCP.GKE.Clusters.legacyAbacUnknownConfiguration for the legacy ABAC authorization mode.
GCP.GKE.Clusters.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Clusters.locationsUnknownThe list of Google Compute Engine zones in which the cluster's nodes should be located.
GCP.GKE.Clusters.loggingConfigUnknownLogging configuration for the cluster.
GCP.GKE.Clusters.loggingServiceStringThe logging service the cluster should use to write logs.
GCP.GKE.Clusters.maintenancePolicyUnknownConfigure the maintenance policy for this cluster.
GCP.GKE.Clusters.managedMachineLearningDiagnosticsConfigUnknownConfiguration for Managed Machine Learning Diagnostics.
GCP.GKE.Clusters.managedOpentelemetryConfigUnknownConfiguration for Managed OpenTelemetry pipeline.
GCP.GKE.Clusters.masterAuthUnknownThe authentication information for accessing the master endpoint.
GCP.GKE.Clusters.masterAuthorizedNetworksConfigUnknownThe configuration options for master authorized networks feature.
GCP.GKE.Clusters.meshCertificatesUnknownConfiguration for issuance of mTLS keys and certificates to Kubernetes pods.
GCP.GKE.Clusters.monitoringConfigUnknownMonitoring configuration for the cluster.
GCP.GKE.Clusters.monitoringServiceStringThe monitoring service the cluster should use to write metrics.
GCP.GKE.Clusters.nameStringThe name of this cluster.
GCP.GKE.Clusters.networkStringThe name of the Google Compute Engine network to which the cluster is connected.
GCP.GKE.Clusters.networkConfigUnknownConfiguration for cluster networking.
GCP.GKE.Clusters.networkPolicyUnknownConfiguration options for the NetworkPolicy feature.
GCP.GKE.Clusters.nodeConfigUnknownParameters used in creating the cluster's nodes.
GCP.GKE.Clusters.nodeCreationConfigUnknownConfiguration for Node Creation Mode.
GCP.GKE.Clusters.nodeIpv4CidrSizeNumberThe size of the address space on each node for hosting containers.
GCP.GKE.Clusters.nodePoolAutoConfigUnknownNode pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
GCP.GKE.Clusters.nodePoolDefaultsUnknownDefault NodePool settings for the entire cluster.
GCP.GKE.Clusters.nodePoolsUnknownThe node pools associated with this cluster.
GCP.GKE.Clusters.notificationConfigUnknownNotification configuration of the cluster.
GCP.GKE.Clusters.parentProductConfigUnknownThe configuration of the parent product of the cluster.
GCP.GKE.Clusters.podAutoscalingUnknownThe config for pod autoscaling.
GCP.GKE.Clusters.privateClusterConfigUnknownConfiguration for private cluster.
GCP.GKE.Clusters.rbacBindingConfigUnknownRBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
GCP.GKE.Clusters.releaseChannelUnknownRelease channel configuration.
GCP.GKE.Clusters.resourceLabelsUnknownThe resource labels for the cluster to use to annotate any related Google Compute Engine resources.
GCP.GKE.Clusters.resourceUsageExportConfigUnknownConfiguration for exporting resource usages.
GCP.GKE.Clusters.rollbackSafeUpgradeUnknownThe rollback safe upgrade information of the cluster.
GCP.GKE.Clusters.satisfiesPziBooleanReserved for future use.
GCP.GKE.Clusters.satisfiesPzsBooleanReserved for future use.
GCP.GKE.Clusters.scheduleUpgradeConfigUnknownConfiguration for scheduled upgrades.
GCP.GKE.Clusters.secretManagerConfigUnknownSecret CSI driver configuration.
GCP.GKE.Clusters.secretSyncConfigUnknownConfiguration for sync Secret Manager secrets as k8s secrets.
GCP.GKE.Clusters.securityPostureConfigUnknownEnable/Disable Security Posture API features for the cluster.
GCP.GKE.Clusters.selfLinkStringServer-defined URL for the resource.
GCP.GKE.Clusters.servicesIpv4CidrStringThe IP address range of the Kubernetes services in this cluster, in CIDR notation.
GCP.GKE.Clusters.shieldedNodesUnknownShielded Nodes configuration.
GCP.GKE.Clusters.statusStringThe current status of this cluster.
GCP.GKE.Clusters.statusMessageStringThe statusMessage of the resource.
GCP.GKE.Clusters.subnetworkStringThe name of the Google Compute Engine subnetwork to which the cluster is connected.
GCP.GKE.Clusters.tpuIpv4CidrBlockStringThe IP address range of the Cloud TPUs in this cluster, in CIDR notation.
GCP.GKE.Clusters.userManagedKeysConfigUnknownThe Custom keys configuration for the cluster.
GCP.GKE.Clusters.verticalPodAutoscalingUnknownCluster-level Vertical Pod Autoscaling configuration.
GCP.GKE.Clusters.workloadIdentityConfigUnknownConfiguration for the use of Kubernetes Service Accounts in IAM policies.
GCP.GKE.Clusters.zoneStringThe name of the Google Compute Engine zone in which the cluster resides.

gcp-gke-node-pools-list#


Lists the node pools for a GKE cluster. Required permissions: container.clusters.get.

Base Command#

gcp-gke-node-pools-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the cluster.Required
clusterThe name of the GKE cluster.Required

Context Output#

PathTypeDescription
GCP.GKE.NodePools.autoscalingUnknownAutoscaler configuration for this NodePool.
GCP.GKE.NodePools.bestEffortProvisioningUnknownEnable best effort provisioning for nodes.
GCP.GKE.NodePools.conditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.NodePools.configUnknownThe node configuration of the pool.
GCP.GKE.NodePools.etagStringThis checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
GCP.GKE.NodePools.initialNodeCountNumberThe initial node count for the pool.
GCP.GKE.NodePools.instanceGroupUrlsUnknownThe resource URLs of the managed instance groups associated with this node pool.
GCP.GKE.NodePools.kubeletCertInfoUnknownContains expiry information about the kubelet certificate.
GCP.GKE.NodePools.locationsUnknownThe list of Google Compute Engine zones in which the NodePool's nodes should be located.
GCP.GKE.NodePools.maintenancePolicyUnknownSpecifies the maintenance policy for the node pool.
GCP.GKE.NodePools.managementUnknownNodeManagement configuration for this NodePool.
GCP.GKE.NodePools.maxPodsConstraintUnknownThe constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
GCP.GKE.NodePools.nameStringThe name of the node pool.
GCP.GKE.NodePools.networkConfigUnknownNetworking configuration for this NodePool.
GCP.GKE.NodePools.nodeDrainConfigUnknownSpecifies the node drain configuration for this node pool.
GCP.GKE.NodePools.placementPolicyUnknownSpecifies the node placement policy.
GCP.GKE.NodePools.podIpv4CidrSizeNumberThe pod CIDR block size per node in this node pool.
GCP.GKE.NodePools.queuedProvisioningUnknownSpecifies the configuration of queued provisioning.
GCP.GKE.NodePools.selfLinkStringServer-defined URL for the resource.
GCP.GKE.NodePools.statusStringThe status of the nodes in this pool instance.
GCP.GKE.NodePools.statusMessageStringAdditional information about the current status of the node pool, if available.
GCP.GKE.NodePools.updateInfoUnknownUpdate info contains relevant information during a node pool update.
GCP.GKE.NodePools.upgradeSettingsUnknownUpgrade settings control disruption and speed of the upgrade.
GCP.GKE.NodePools.versionStringThe version of Kubernetes running on this NodePool's nodes.
GCP.GKE.NodePools.config.machineTypeStringThe machine type of the Compute Engine instances in the node pool.
GCP.GKE.NodePools.config.diskSizeGbNumberThe disk size (in GB) of the nodes in the node pool.
GCP.GKE.NodePools.autoscaling.enabledBooleanWhether autoscaling is enabled for the node pool.
GCP.GKE.NodePools.autoscaling.minNodeCountNumberThe minimum number of nodes when autoscaling is enabled.
GCP.GKE.NodePools.autoscaling.maxNodeCountNumberThe maximum number of nodes when autoscaling is enabled.
GCP.GKE.NodePools.management.autoRepairBooleanWhether node auto-repair is enabled for the node pool.
GCP.GKE.NodePools.management.autoUpgradeBooleanWhether node auto-upgrade is enabled for the node pool.

gcp-gke-node-pool-get#


Gets the details of a specific node pool in a GKE cluster. Required permissions: container.clusters.get.

Base Command#

gcp-gke-node-pool-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the cluster.Required
clusterThe name of the GKE cluster.Required
node_poolThe name of the node pool.Required

Context Output#

PathTypeDescription
GCP.GKE.NodePools.autoscalingUnknownAutoscaler configuration for this NodePool.
GCP.GKE.NodePools.bestEffortProvisioningUnknownEnable best effort provisioning for nodes.
GCP.GKE.NodePools.conditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.NodePools.configUnknownThe node configuration of the pool.
GCP.GKE.NodePools.etagStringThis checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
GCP.GKE.NodePools.initialNodeCountNumberThe initial node count for the pool.
GCP.GKE.NodePools.instanceGroupUrlsUnknownThe resource URLs of the managed instance groups associated with this node pool.
GCP.GKE.NodePools.kubeletCertInfoUnknownContains expiry information about the kubelet certificate.
GCP.GKE.NodePools.locationsUnknownThe list of Google Compute Engine zones in which the NodePool's nodes should be located.
GCP.GKE.NodePools.maintenancePolicyUnknownSpecifies the maintenance policy for the node pool.
GCP.GKE.NodePools.managementUnknownNodeManagement configuration for this NodePool.
GCP.GKE.NodePools.maxPodsConstraintUnknownThe constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
GCP.GKE.NodePools.nameStringThe name of the node pool.
GCP.GKE.NodePools.networkConfigUnknownNetworking configuration for this NodePool.
GCP.GKE.NodePools.nodeDrainConfigUnknownSpecifies the node drain configuration for this node pool.
GCP.GKE.NodePools.placementPolicyUnknownSpecifies the node placement policy.
GCP.GKE.NodePools.podIpv4CidrSizeNumberThe pod CIDR block size per node in this node pool.
GCP.GKE.NodePools.queuedProvisioningUnknownSpecifies the configuration of queued provisioning.
GCP.GKE.NodePools.selfLinkStringServer-defined URL for the resource.
GCP.GKE.NodePools.statusStringThe status of the nodes in this pool instance.
GCP.GKE.NodePools.statusMessageStringAdditional information about the current status of the node pool, if available.
GCP.GKE.NodePools.updateInfoUnknownUpdate info contains relevant information during a node pool update.
GCP.GKE.NodePools.upgradeSettingsUnknownUpgrade settings control disruption and speed of the upgrade.
GCP.GKE.NodePools.versionStringThe version of Kubernetes running on this NodePool's nodes.
GCP.GKE.NodePools.config.machineTypeStringThe machine type of the Compute Engine instances in the node pool.
GCP.GKE.NodePools.config.diskSizeGbNumberThe disk size (in GB) of the nodes in the node pool.
GCP.GKE.NodePools.autoscaling.enabledBooleanWhether autoscaling is enabled for the node pool.
GCP.GKE.NodePools.autoscaling.minNodeCountNumberThe minimum number of nodes when autoscaling is enabled.
GCP.GKE.NodePools.autoscaling.maxNodeCountNumberThe maximum number of nodes when autoscaling is enabled.
GCP.GKE.NodePools.management.autoRepairBooleanWhether node auto-repair is enabled for the node pool.
GCP.GKE.NodePools.management.autoUpgradeBooleanWhether node auto-upgrade is enabled for the node pool.

gcp-gke-node-pool-management-set#


Enables or disables the auto-repair and/or auto-upgrade management features of a node pool. Required permissions: container.clusters.update.

Base Command#

gcp-gke-node-pool-management-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the cluster.Required
clusterThe name of the GKE cluster.Required
node_poolThe name of the node pool.Required
auto_repairWhether to enable node auto-repair for the node pool. Possible values are: true, false.Optional
auto_upgradeWhether to enable node auto-upgrade for the node pool. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.GKE.Operations.clusterConditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Operations.detailStringDetailed operation progress, if available.
GCP.GKE.Operations.endTimeStringThe time the operation completed, in RFC3339 text format.
GCP.GKE.Operations.errorUnknownThe error result of the operation in case of failure.
GCP.GKE.Operations.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Operations.nameStringThe server-assigned ID for the operation.
GCP.GKE.Operations.nodepoolConditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.Operations.operationTypeStringThe operation type.
GCP.GKE.Operations.progressUnknownProgress information for an operation.
GCP.GKE.Operations.selfLinkStringServer-defined URI for the operation.
GCP.GKE.Operations.startTimeStringThe time the operation started, in RFC3339 text format.
GCP.GKE.Operations.statusStringThe current status of the operation.
GCP.GKE.Operations.statusMessageStringIf an error has occurred, a textual description of the error.
GCP.GKE.Operations.targetLinkStringServer-defined URI for the target of the operation.
GCP.GKE.Operations.zoneStringThe name of the Google Compute Engine zone in which the operation is taking place.

gcp-gke-operations-list#


Lists all GKE operations in a project for the specified location. Required permissions: container.operations.list.

Base Command#

gcp-gke-operations-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) to list operations from. Use "-" to list operations from all locations.Required

Context Output#

PathTypeDescription
GCP.GKE.Operations.clusterConditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Operations.detailStringDetailed operation progress, if available.
GCP.GKE.Operations.endTimeStringThe time the operation completed, in RFC3339 text format.
GCP.GKE.Operations.errorUnknownThe error result of the operation in case of failure.
GCP.GKE.Operations.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Operations.nameStringThe server-assigned ID for the operation.
GCP.GKE.Operations.nodepoolConditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.Operations.operationTypeStringThe operation type.
GCP.GKE.Operations.progressUnknownProgress information for an operation.
GCP.GKE.Operations.selfLinkStringServer-defined URI for the operation.
GCP.GKE.Operations.startTimeStringThe time the operation started, in RFC3339 text format.
GCP.GKE.Operations.statusStringThe current status of the operation.
GCP.GKE.Operations.statusMessageStringIf an error has occurred, a textual description of the error.
GCP.GKE.Operations.targetLinkStringServer-defined URI for the target of the operation.
GCP.GKE.Operations.zoneStringThe name of the Google Compute Engine zone in which the operation is taking place.

gcp-gke-operation-get#


Gets the details of a specific GKE operation. Required permissions: container.operations.get.

Base Command#

gcp-gke-operation-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the operation.Required
operationThe name of the operation.Required

Context Output#

PathTypeDescription
GCP.GKE.Operations.clusterConditionsUnknownWhich conditions caused the current cluster state.
GCP.GKE.Operations.detailStringDetailed operation progress, if available.
GCP.GKE.Operations.endTimeStringThe time the operation completed, in RFC3339 text format.
GCP.GKE.Operations.errorUnknownThe error result of the operation in case of failure.
GCP.GKE.Operations.locationStringThe name of the Google Compute Engine zone or region in which the cluster resides.
GCP.GKE.Operations.nameStringThe server-assigned ID for the operation.
GCP.GKE.Operations.nodepoolConditionsUnknownWhich conditions caused the current node pool state.
GCP.GKE.Operations.operationTypeStringThe operation type.
GCP.GKE.Operations.progressUnknownProgress information for an operation.
GCP.GKE.Operations.selfLinkStringServer-defined URI for the operation.
GCP.GKE.Operations.startTimeStringThe time the operation started, in RFC3339 text format.
GCP.GKE.Operations.statusStringThe current status of the operation.
GCP.GKE.Operations.statusMessageStringIf an error has occurred, a textual description of the error.
GCP.GKE.Operations.targetLinkStringServer-defined URI for the target of the operation.
GCP.GKE.Operations.zoneStringThe name of the Google Compute Engine zone in which the operation is taking place.

gcp-gke-operation-cancel#


Cancels a specific GKE operation. Required permissions: container.operations.get.

Base Command#

gcp-gke-operation-cancel

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP location (zone or region) of the operation.Required
operationThe name of the operation.Required

Context Output#

There is no context output for this command.

gcp-storage-bucket-metadata-update#


Updates Google Cloud Storage (GCS) bucket metadata, including settings such as versioning and Uniform Bucket-Level Access (UBLA). Required permission: storage.buckets.update.

Base Command#

gcp-storage-bucket-metadata-update

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameName of the bucket.Required
enable_versioningEnable versioning. Possible values are: true, false.Optional
enable_uniform_accessEnable uniform bucket-level access. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.nameStringThe name of the GCP bucket.
GCP.Storage.Buckets.idStringThe ID of the GCP bucket.
GCP.Storage.Buckets.locationStringThe location of the bucket.
GCP.Storage.Buckets.storageClassStringThe storage class of the bucket (e.g., STANDARD, NEARLINE).
GCP.Storage.Buckets.createdDateThe creation timestamp of the bucket (e.g., 2024-01-15T12:34:56Z).
GCP.Storage.Buckets.updatedDateThe last update timestamp of the bucket.
GCP.Storage.Buckets.metagenerationNumberThe metadata generation of the bucket.
GCP.Storage.Buckets.labelsUnknownThe labels attached to the bucket.
GCP.Storage.Buckets.defaultEventBasedHoldBooleanWhether a default event-based hold is enabled on the bucket.
GCP.Storage.Buckets.retentionPolicy.retentionPeriodNumberThe duration in seconds that objects in the bucket must be retained.
GCP.Storage.Buckets.retentionPolicy.effectiveTimeDateThe time from which the retention policy is effective.
GCP.Storage.Buckets.retentionPolicy.isLockedBooleanWhether the retention policy is locked.
GCP.Storage.Buckets.versioning.enabledBooleanWhether object versioning is enabled.
GCP.Storage.Buckets.logging.logBucketStringThe destination bucket where access logs are stored.
GCP.Storage.Buckets.logging.logObjectPrefixStringThe object prefix used for logging.
GCP.Storage.Buckets.lifecycle.ruleUnknownA list of lifecycle management rules for the bucket.
GCP.Storage.Buckets.iamConfiguration.uniformBucketLevelAccessBooleanWhether uniform bucket-level access is enabled.
GCP.Storage.Buckets.corsUnknownCORS configuration for the bucket.
GCP.Storage.Buckets.customPlacementConfigUnknownCustom placement configuration for multi-region buckets.
GCP.Storage.Buckets.encryption.defaultKmsKeyNameStringThe default Cloud KMS key used to encrypt objects.
GCP.Storage.Buckets.billing.requesterPaysBooleanWhether requester pays is enabled.
GCP.Storage.Buckets.website.mainPageSuffixStringSuffix appended to requests for the bucket's website configuration.
GCP.Storage.Buckets.website.notFoundPageStringThe path to the custom 404 page for the bucket website.

gcp-iam-project-policy-binding-remove#


Removes a specified IAM role binding from a GCP project. Required permissions: resourcemanager.projects.getIamPolicy, resourcemanager.projects.setIamPolicy.

Base Command#

gcp-iam-project-policy-binding-remove

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
memberMember to remove (e.g., user:test@example.com).Required
roleRole to remove (e.g., roles/viewer).Required

Context Output#

There is no context output for this command.

gcp-compute-instance-service-account-set#


Sets the service account for a GCP Compute Engine VM instance. The instance must be stopped before the service account can be changed. Required permissions: compute.instances.setServiceAccount, compute.instances.get.

Base Command#

gcp-compute-instance-service-account-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameName of the VM instance.Required
service_account_emailEmail of the service account.Required
scopesOAuth scopes to assign (full URLs), e.g., https://www.googleapis.com/auth/cloud-platform. Empty list means no scopes.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-service-account-remove#


Removes the service account associated with a GCP Compute Engine VM instance. The instance must be stopped before the service account can be changed. Required permissions: compute.instances.setServiceAccount, compute.instances.get.

Base Command#

gcp-compute-instance-service-account-remove

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameName of the VM instance.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-start#


Starts an instance that was stopped using the instances().stop method. Required permission: compute.instances.start.

Base Command#

gcp-compute-instance-start

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameName of the instance resource to start.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-stop#


Stops and cleanly shuts down a running instance, allowing you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using such as persistent disks and static IP addresses will continue to be charged until they are deleted. Required permission: compute.instances.stop.

Base Command#

gcp-compute-instance-stop

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameName of the instance resource to stop.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not configurable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instances-list#


Retrieves the list of instances in the specified zone. Required permission: compute.instances.list.

Base Command#

gcp-compute-instances-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
filtersA filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a Compute Engine instance named example-instance, use name != example-instance.Optional
limitThe maximum number of results per page that should be returned. Acceptable values are 0 to 500, inclusive. Default is 50.Optional
order_bySorts list results in a specific order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using order_by="creationTimestamp desc".Optional
page_tokenSpecifies a page token. Set page_token to the nextPageToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.Instances.kindStringType of the resource.Always compute#instance for instances.
GCP.Compute.Instances.idStringThe unique identifier of the resource.
GCP.Compute.Instances.creationTimestampStringCreation timestamp in RFC3339 text format.
GCP.Compute.Instances.nameStringThe name of the resource, provided by the client when the resource is first created.
GCP.Compute.Instances.descriptionStringAn optional description for this resource.
GCP.Compute.Instances.tagsStringTags to apply to this instance.
GCP.Compute.Instances.machineTypeStringFull or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type.
GCP.Compute.Instances.statusStringThe status of the instance.
GCP.Compute.Instances.statusMessageStringAn optional, human-readable explanation of the status.
GCP.Compute.Instances.zoneStringURL of the zone where the instance resides.
GCP.Compute.Instances.canIpForwardStringAllows this instance to send and receive packets with non-matching destination or source IPs.
GCP.Compute.Instances.networkInterfacesObjectAn array of network configurations for the instance.
GCP.Compute.Instances.disksObjectArray of disks associated with the instance.
GCP.Compute.Instances.metadataObjectThe metadata key/value pairs assigned to the instance.
GCP.Compute.Instances.serviceAccountsObjectA list of service accounts, with their specified scopes, authorized for the instance.
GCP.Compute.Instances.selfLinkStringServer-defined URL for the resource.
GCP.Compute.Instances.schedulingObjectSets the scheduling options for the instance.
GCP.Compute.Instances.cpuPlatformStringThe CPU platform used by the instance.
GCP.Compute.Instances.labelsStringLabels to apply to the instance.
GCP.Compute.Instances.labelFingerprintStringA fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking.
GCP.Compute.Instances.instanceEncryptionKeyObjectEncrypts suspended data for an instance with a customer-managed encryption key.
GCP.Compute.Instances.minCpuPlatformStringSpecifies a minimum CPU platform for the VM instance.
GCP.Compute.Instances.guestAcceleratorsObjectA list of the type and count of accelerator cards attached to the instance.
GCP.Compute.Instances.startRestrictedBooleanIndicates whether a VM has been restricted from starting because Compute Engine detected suspicious activity.
GCP.Compute.Instances.deletionProtectionBooleanWhether the resource should be protected against deletion.
GCP.Compute.Instances.resourcePoliciesStringResource policies applied to this instance.
GCP.Compute.Instances.sourceMachineImageStringSource machine image.
GCP.Compute.Instances.reservationAffinityObjectSpecifies the reservations that the instance can consume from.
GCP.Compute.Instances.hostnameStringSpecifies the hostname of the instance.
GCP.Compute.Instances.displayDeviceObjectEnables display device for the instance.
GCP.Compute.Instances.shieldedInstanceConfigObjectShielded VM configuration for the instance.
GCP.Compute.Instances.sourceMachineImageEncryptionKeyObjectThe source machine image encryption key used when creating an instance from a machine image.
GCP.Compute.Instances.confidentialInstanceConfigObjectConfidential computing configuration for the instance.
GCP.Compute.Instances.fingerprintStringSpecifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking.
GCP.Compute.Instances.privateIpv6GoogleAccessStringThe private IPv6 Google access type for the VM.
GCP.Compute.Instances.advancedMachineFeaturesObjectControls for advanced machine-related behavior features.
GCP.Compute.Instances.lastStartTimestampStringLast start timestamp in RFC3339 text format.
GCP.Compute.Instances.lastStopTimestampStringLast stop timestamp in RFC3339 text format.
GCP.Compute.Instances.lastSuspendedTimestampStringLast suspended timestamp in RFC3339 text format.
GCP.Compute.Instances.satisfiesPzsStringIndicates whether the instance satisfies physical zone separation requirements.
GCP.Compute.Instances.satisfiesPziStringIndicates whether the instance satisfies physical zone isolation requirements.
GCP.Compute.Instances.resourceStatusObjectThe resource status.
GCP.Compute.Instances.networkPerformanceConfigObjectNetwork performance configuration.
GCP.Compute.Instances.keyRevocationActionTypeStringKeyRevocationActionType of the instance.
GCP.Compute.InstancesNextPageTokenStringThe token used to retrieve the next page of results for list requests.
GCP.Compute.InstancesSelfLinkStringServer-defined URL for the resource.
GCP.Compute.InstancesWarningObjectInformational warning message.

gcp-compute-instance-labels-set#


Sets labels on an instance. Required permission: compute.instances.setLabels.

Base Command#

gcp-compute-instance-labels-set

Input#

Argument NameDescriptionRequired
instanceName of the instance resource to return.Required
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
labelsAn object containing a list of "key": value pairs, without spaces. Example: key=abc,value=123;key=ABC,value=321.Required
label_fingerprintFingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.Required
add_labelsWhether to add the new labels to the existing ones or override the previous labels with the news. True - add, False - override. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For snapshot-creation operations, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringUser who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator ranging from 0 to 100. It does not need to be linear or support any specific granularity of operations. This indicator should not be used to estimate completion time. The value should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-get#


Returns a specific instance resource. To get a list of available instances, make a list() request. Required permission: compute.instances.get.

Base Command#

gcp-compute-instance-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
instanceName of the instance resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Instances.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Instances.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Instances.namestringThe name of the resource, provided by the client when first creating it. The name must be 1–63 characters long and comply with RFC1035. It must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, meaning the first character must be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Instances.descriptionstringAn optional description of this resource. Provide this property when you create the resource.
GCP.Compute.Instances.tagsstringTags to apply to this instance. Tags identify valid sources or targets for network firewalls and are specified by the client during instance creation. Tags can later be modified using the setTags method. Each tag must comply with RFC1035. Multiple tags can be specified via the tags.items field.
GCP.Compute.Instances.tags.itemsstringAn array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
GCP.Compute.Instances.tags.fingerprintstringSpecifies a fingerprint for this request, which is essentially a hash of the tags contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
GCP.Compute.Instances.machineTypestringFull or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created.
GCP.Compute.Instances.statusstringThe status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.
GCP.Compute.Instances.statusMessagestringAn optional, human-readable explanation of the status.
GCP.Compute.Instances.zonestringURL of the zone where the instance resides. This field must be specified in the HTTP request URL and cannot be set in the request body.
GCP.Compute.Instances.canIpForwardbooleanAllows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.
GCP.Compute.Instances.networkInterfacesstringAn array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
GCP.Compute.Instances.networkInterfaces.networkstringURL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
GCP.Compute.Instances.networkInterfaces.subnetworkstringThe URL of the Subnetwork resource for this instance. For legacy networks, do not provide this property. For auto subnet networks, specifying the subnetwork is optional. For custom subnet networks, this field must be specified. If provided, the subnetwork can be a full or partial URL.
GCP.Compute.Instances.networkInterfaces.networkIPstringAn IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
GCP.Compute.Instances.networkInterfaces.namestringThe name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
GCP.Compute.Instances.networkInterfaces.accessConfigsstringAn array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then the instance will have no external internet access.
GCP.Compute.Instances.networkInterfaces.aliasIpRangesstringAn array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
GCP.Compute.Instances.networkInterfaces.fingerprintstringFingerprint hash of the contents stored in this network interface. This field is ignored when inserting an instance or adding a network interface. To update the network interface, an up-to-date fingerprint must be provided; otherwise, the request fails with error 412 conditionNotMet.
GCP.Compute.Instances.networkInterfaces.kindstringType of the resource. Always compute#networkInterface for network interfaces.
GCP.Compute.Instances.disksstringArray of disks associated with this instance. Persistent disks must be created before you can assign them.
GCP.Compute.Instances.disks.typestringSpecifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
GCP.Compute.Instances.disks.modestringThe mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
GCP.Compute.Instances.disks.sourcestringSpecifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.
GCP.Compute.Instances.disks.deviceNamestringSpecifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and other operations from within the instance.
GCP.Compute.Instances.disks.indexnumberA zero-based index for this disk, where 0 is reserved for the boot disk. Each attached disk on an instance has a unique index number.
GCP.Compute.Instances.disks.bootbooleanIndicates that this is a boot disk. The VM uses the first partition of the disk as its root filesystem.
GCP.Compute.Instances.disks.initializeParamsstringSpecifies parameters for a new disk to be created with the instance. Use initialization parameters to create boot disks or local SSDs attached to the instance.
GCP.Compute.Instances.disks.autoDeletebooleanSpecifies whether the disk is auto-deleted when the instance is deleted (not when the disk is detached).
GCP.Compute.Instances.disks.licensesstringAny valid publicly visible licenses.
GCP.Compute.Instances.disks.interfacestringSpecifies the disk interface for attaching this disk, either SCSI or NVME. The default is SCSI. Persistent disks must use SCSI; attaching a persistent disk with any other interface will fail. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI versus NVMe, see Local SSD performance.
GCP.Compute.Instances.disks.guestOsFeaturesstringA list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
GCP.Compute.Instances.disks.diskEncryptionKeyObjectEncrypts or decrypts a disk using a customer-supplied encryption key.
GCP.Compute.Instances.disks.kindstringType of the resource. Always compute#attachedDisk for attached disks.
GCP.Compute.Instances.metadatastringThe metadata key/value pairs assigned to the instance. This includes custom metadata and predefined keys.
GCP.Compute.Instances.metadata.fingerprintstringSpecifies a fingerprint for this request, which is a hash of the metadata contents used for optimistic locking. The fingerprint is generated by Compute Engine and changes after every metadata update. You must provide an up-to-date fingerprint to modify metadata; otherwise, the request fails with error 412 conditionNotMet.
GCP.Compute.Instances.metadata.itemsstringArray of key/value pairs. The total size of all keys and values must be less than 512 KB.
GCP.Compute.Instances.metadata.kindstringType of the resource. Always compute#metadata for metadata.
GCP.Compute.Instances.serviceAccountsstringA list of service accounts, with their specified scopes, authorized for the instance. Only one service account per VM instance is supported.
GCP.Compute.Instances.serviceAccounts.emailstringEmail address of the service account.
GCP.Compute.Instances.serviceAccounts.scopesstringThe list of scopes to be made available for this service account.
GCP.Compute.Instances.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Instances.schedulingstringSets the scheduling options for the instance.
GCP.Compute.Instances.scheduling.onHostMaintenancestringDefines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
GCP.Compute.Instances.scheduling.automaticRestartbooleanSpecifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
GCP.Compute.Instances.scheduling.preemptiblebooleanDefines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.
GCP.Compute.Instances.scheduling.nodeAffinitiesstringA set of node affinity and anti-affinity.
GCP.Compute.Instances.cpuPlatformstringThe CPU platform used by the instance.
GCP.Compute.Instances.labelsstringLabels to apply to the instance. These can be later modified by the setLabels method.
GCP.Compute.Instances.labels.keystringThe label key.
GCP.Compute.Instances.labels.valuestringThe label value.
GCP.Compute.Instances.labelFingerprintstringA fingerprint for this request, which is essentially a hash of the labels contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Instances.minCpuPlatformstringSpecifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".
GCP.Compute.Instances.guestAcceleratorsstringA list of the type and count of accelerator cards attached to the instance.
GCP.Compute.Instances.guestAccelerators.acceleratorTypestringFull or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100. When creating an instance template, specify only the accelerator name.
GCP.Compute.Instances.guestAccelerators.acceleratorCountstringThe number of the guest accelerator cards exposed to the instance.
GCP.Compute.Instances.startRestrictedbooleanIndicates whether a VM has been restricted from starting because Compute Engine detected suspicious activity.
GCP.Compute.Instances.deletionProtectionbooleanWhether the resource should be protected against deletion.
GCP.Compute.Instances.hostnamestringHostname.
GCP.Compute.Instances.kindstringType of the resource. Always compute#instance for instances.

gcp-storage-bucket-list#


Retrieves the list of buckets in the project associated with the client. The command is deprecated, please use gcp-storage-buckets-list. Required permission: storage.buckets.list.

Base Command#

gcp-storage-bucket-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitMaximum number of buckets to return.Optional
prefixFilter results to buckets whose names begin with this prefix.Optional
page_tokenToken for pagination.Optional

Context Output#

PathTypeDescription
GCP.Storage.Bucket.idStringThe unique identifier for the bucket.
GCP.Storage.Bucket.nameStringThe name of the bucket.
GCP.Storage.Bucket.kindStringThe type of resource (for example, storage#bucket).
GCP.Storage.Bucket.locationStringThe location of the bucket.
GCP.Storage.Bucket.locationTypeStringThe type of location (for example, multi-region).
GCP.Storage.Bucket.projectNumberStringThe GCP project number associated with the bucket.
GCP.Storage.Bucket.storageClassStringThe storage class of the bucket.
GCP.Storage.Bucket.rpoStringThe recovery point objective setting of the bucket.
GCP.Storage.Bucket.etagStringThe HTTP entity tag of the bucket.
GCP.Storage.Bucket.generationStringThe generation number of the bucket.
GCP.Storage.Bucket.metagenerationStringThe metageneration number of the bucket.
GCP.Storage.Bucket.timeCreatedDateThe time the bucket was created.
GCP.Storage.Bucket.timeUpdatedDateThe time the bucket was last updated.
GCP.Storage.Bucket.selfLinkStringThe link to the bucket resource on the GCP API.

gcp-storage-bucket-get#


Retrieves information about a specific bucket. Required permission: storage.buckets.get.

Base Command#

gcp-storage-bucket-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket to retrieve.Required

Context Output#

PathTypeDescription
GCP.Storage.Buckets.idStringThe unique identifier for the bucket.
GCP.Storage.Buckets.nameStringThe name of the bucket.
GCP.Storage.Buckets.kindStringThe type of resource (for example, storage#bucket).
GCP.Storage.Buckets.locationStringThe location of the bucket.
GCP.Storage.Buckets.locationTypeStringThe type of location (for example, multi-region).
GCP.Storage.Buckets.projectNumberStringThe GCP project number associated with the bucket.
GCP.Storage.Buckets.storageClassStringThe storage class of the bucket.
GCP.Storage.Buckets.rpoStringThe recovery point objective setting of the bucket.
GCP.Storage.Buckets.etagStringThe HTTP entity tag of the bucket.
GCP.Storage.Buckets.generationStringThe generation number of the bucket.
GCP.Storage.Buckets.metagenerationStringThe metageneration number of the bucket.
GCP.Storage.Buckets.timeCreatedDateThe time the bucket was created (e.g., 2024-01-15T12:34:56Z).
GCP.Storage.Buckets.timeUpdatedDateThe time the bucket was last updated.
GCP.Storage.Buckets.selfLinkStringThe link to the bucket resource on the GCP API.

gcp-storage-bucket-objects-list#


Retrieves the list of objects in a bucket. Required permission: storage.objects.list.

Base Command#

gcp-storage-bucket-objects-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket to list objects from.Required
prefixFilter results to objects whose names begin with this prefix.Optional
delimiterDelimiter to use for grouping objects. For example delimiter="/" Returns results in a directory-like mode, with / being a common value for the delimiter.Optional
limitMaximum number of objects to return.Optional
page_tokenThe token for pagination.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.Objects.idStringThe unique identifier for the object.
GCP.Storage.Buckets.Objects.nameStringThe name of the object.
GCP.Storage.Buckets.Objects.kindStringThe type of resource (for example, storage#object).
GCP.Storage.Buckets.Objects.bucketStringThe name of the bucket containing the object.
GCP.Storage.Buckets.Objects.contentTypeStringThe MIME type of the object.
GCP.Storage.Buckets.Objects.sizeNumberThe size of the object in bytes.
GCP.Storage.Buckets.Objects.crc32cStringThe CRC32C checksum of the object.
GCP.Storage.Buckets.Objects.md5HashStringThe MD5 hash of the object.
GCP.Storage.Buckets.Objects.etagStringThe HTTP entity tag of the object.
GCP.Storage.Buckets.Objects.generationStringThe generation number of the object.
GCP.Storage.Buckets.Objects.metagenerationStringThe metageneration number of the object.
GCP.Storage.Buckets.Objects.storageClassStringThe storage class of the object.
GCP.Storage.Buckets.Objects.mediaLinkStringThe link for downloading the object content.
GCP.Storage.Buckets.Objects.selfLinkStringThe link to the object resource in the GCP API.
GCP.Storage.Buckets.Objects.timeCreatedDateThe time when the object was created.
GCP.Storage.Buckets.Objects.timeFinalizedDateThe time when the object was finalized.
GCP.Storage.Buckets.Objects.timeStorageClassUpdatedDateThe time when the object's storage class was last updated.
GCP.Storage.Buckets.Objects.updatedDateThe time when the object was last modified.
GCP.Storage.Buckets.ObjectsNextTokenStringThe continuation token. Provide this value as the page_token of a subsequent request in order to return the next page of results.
GCP.Storage.Buckets.nameStringThe name of the bucket containing the object.

gcp-storage-bucket-policy-list#


Retrieves the IAM policy for a bucket. The command is deprecated, please use gcp-storage-bucket-policies-list. Required permissions: storage.buckets.getIamPolicy, storage.buckets.get.

Base Command#

gcp-storage-bucket-policy-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket to retrieve IAM policy from.Required
requested_policy_versionThe IAM policy version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails. Required to be 3 or greater for buckets with IAM Conditions.Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketPolicy.versionNumberIAM policy version.
GCP.Storage.BucketPolicy.etagStringETag of the IAM policy.
GCP.Storage.BucketPolicy.bindingsListList of role bindings for the bucket.
GCP.Storage.BucketPolicy.resourceIdStringResource ID of the updated IAM policy. e.g. projects/_/buckets/BUCKET_NAME.

Usage#

  • add=false: Replaces the entire bucket IAM policy with the JSON provided in policy.
  • add=true: Reads the current bucket policy (getIamPolicy), merges the provided bindings per role (deduplicates members), and updates the bucket policy (setIamPolicy) while preserving other top-level fields.

gcp-storage-bucket-policy-set#


Sets the IAM policy for a bucket. Required permission: storage.buckets.setIamPolicy.

Base Command#

gcp-storage-bucket-policy-set

Usage#

  • add=false: Replaces the entire bucket IAM policy with the JSON provided in policy.
  • add=true: Reads the current bucket policy (getIamPolicy), merges the provided bindings per role (deduplicates members), and updates the bucket policy (setIamPolicy) while preserving other top-level fields.

Warning: Use this command with extreme caution. Running it without explicitly merging (i.e., with add=false) will overwrite the bucket's existing IAM policy with the provided policy. If you intend to keep current bindings and add new ones, use add=true.

Policy structure#

  • bindings: Array of binding objects. Each binding:
    • role: String. For example, roles/storage.objectViewer, roles/storage.admin.
    • members: Array of strings. Allowed formats:
      • user:<email> (e.g., user:alice@example.com)
      • group:<email>
      • serviceAccount:<email>
      • domain:<domain> (e.g., domain:example.com)
      • allUsers | allAuthenticatedUsers
  • version: Number. Required to be 3 or greater if any binding includes condition.
  • etag: String. Recommended for replace flow (add=false) to avoid overwriting concurrent updates.
  • Optional fields like kind, resourceId may appear in responses but are not required in requests.

Notes:

  • For add=true (merge), only a valid bindings array is required; other top-level fields are taken from the existing policy.
  • For add=false (replace), the provided object becomes the entire policy on the bucket.

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket to set IAM policy on.Required
policyJSON string representing the IAM policy to set.Required
addWhen true, merges the provided policy bindings into the current bucket policy (per role, deduplicating members) by first calling getIamPolicy and then setIamPolicy with the merged result. When false, replaces the entire policy with the provided JSON via setIamPolicy.
. Possible values are: true, false. Default is false.
Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketPolicies.versionNumberIAM policy version after update.
GCP.Storage.BucketPolicies.etagStringETag of the updated IAM policy.
GCP.Storage.BucketPolicies.bindingsUnknownList of role bindings for the bucket.

gcp-storage-bucket-object-policy-list#


Retrieves the IAM policy for a specific object in a bucket. The command is deprecated, please use gcp-storage-bucket-object-policies-list. Required permission: storage.objects.getIamPolicy.

Base Command#

gcp-storage-bucket-object-policy-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket containing the object.Required
object_nameName of the object to retrieve IAM policy from.Required
generationGeneration of the object.Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketObjectPolicy.bucketNameStringName of the bucket containing the object.
GCP.Storage.BucketObjectPolicy.objectNameStringName of the object.
GCP.Storage.BucketObjectPolicy.bindingsListList of role bindings for the object.

gcp-storage-bucket-object-policy-set#


Sets the IAM policy for a specific object in a bucket. Required permission: storage.objects.setIamPolicy.

Base Command#

gcp-storage-bucket-object-policy-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameName of the bucket containing the object.Required
object_nameName of the object to set IAM policy on.Required
policyJSON string representing the IAM policy to set.Required
generationThe generation of the object (e.g., a positive integer).Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketObjectPolicies.versionNumberIAM policy version after update.
GCP.Storage.BucketObjectPolicies.etagStringETag of the updated IAM policy.
GCP.Storage.BucketObjectPolicies.bindingsUnknownList of role bindings for the object.

gcp-compute-snapshot-get#


Retrieves details for a specific snapshot. Required permission: compute.snapshots.get.

Base Command#

gcp-compute-snapshot-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameSnapshot name.Required

Context Output#

PathTypeDescription
GCP.Compute.Snapshots.idStringUnique identifier for the snapshot resource.
GCP.Compute.Snapshots.nameStringName of the snapshot resource.
GCP.Compute.Snapshots.kindStringType of the resource, for example compute#snapshot.
GCP.Compute.Snapshots.statusStringCurrent status of the snapshot, such as READY or FAILED.
GCP.Compute.Snapshots.autoCreatedBooleanIndicates whether the snapshot was automatically created.
GCP.Compute.Snapshots.architectureStringCPU architecture of the source disk, for example X86_64.
GCP.Compute.Snapshots.creationTimestampDateThe time when the snapshot was created.
GCP.Compute.Snapshots.creationSizeBytesNumberTotal size of the snapshot in bytes at creation time.
GCP.Compute.Snapshots.diskSizeGbNumberSize of the snapshot in gigabytes.
GCP.Compute.Snapshots.downloadBytesNumberTotal bytes downloaded to create the snapshot.
GCP.Compute.Snapshots.enableConfidentialComputeBooleanIndicates if confidential compute is enabled for this snapshot.
GCP.Compute.Snapshots.labelFingerprintStringFingerprint for the labels applied to the snapshot.
GCP.Compute.Snapshots.licenseCodesUnknownList of license code identifiers attached to the snapshot.
GCP.Compute.Snapshots.licensesUnknownList of license URLs associated with the snapshot.
GCP.Compute.Snapshots.selfLinkStringServer-defined URL for the snapshot resource.
GCP.Compute.Snapshots.sourceDiskStringURL of the source disk used to create the snapshot.
GCP.Compute.Snapshots.sourceDiskIdStringUnique ID of the source disk used to create the snapshot.
GCP.Compute.Snapshots.sourceSnapshotSchedulePolicyStringURL of the snapshot schedule policy used to create this snapshot.
GCP.Compute.Snapshots.sourceSnapshotSchedulePolicyIdStringUnique ID of the snapshot schedule policy used to create this snapshot.
GCP.Compute.Snapshots.storageBytesNumberTotal storage size of the snapshot in bytes.
GCP.Compute.Snapshots.storageBytesStatusStringStatus of the storage bytes usage, for example UP_TO_DATE.
GCP.Compute.Snapshots.storageLocationsUnknownList of storage locations for the snapshot.

gcp-compute-snapshot-delete#


Deletes the specified snapshot. Deleting a single snapshot might not delete all data on that snapshot. If any data on the snapshot marked for deletion is needed for subsequent snapshots, the data is moved to the next corresponding snapshot. Required permission: compute.snapshots.delete.

Base Command#

gcp-compute-snapshot-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameThe name of the snapshot to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe current status of the operation.
GCP.Compute.Operations.progressNumberThe progress of the operation as a percentage between 0 and 100.
GCP.Compute.Operations.targetIdStringThe unique target ID of the resource affected by the operation.
GCP.Compute.Operations.targetLinkStringThe URL of the target resource modified by the operation.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe date and time when the operation resource was created.
GCP.Compute.Operations.startTimeDateThe date and time when the operation started running.
GCP.Compute.Operations.userStringThe user account that performed the operation.

gcp-compute-snapshot-labels-set#


Sets the labels on a snapshot. Required permissions: compute.snapshots.setLabels, compute.snapshots.get.

Base Command#

gcp-compute-snapshot-labels-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameThe name of the snapshot for this request.Required
labelsThe labels to apply for this resource. Each label key and value must comply with RFC1035. Example: key=abc,value=123;key=def,value=456.Required
label_fingerprintThe fingerprint of the previous set of labels for this resource, used to detect conflicts. Run gcp-compute-snapshot-get to retrieve the latest fingerprint. Ignored when add_labels is true, since the fingerprint of the fetched snapshot is used instead. When add_labels is false, a label_fingerprint must be provided.Optional
add_labelsWhether to add the new labels to the existing ones or override the previous labels with the new ones. True - add, False - override. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe current status of the operation.
GCP.Compute.Operations.progressNumberThe progress of the operation as a percentage between 0 and 100.
GCP.Compute.Operations.targetIdStringThe unique target ID of the resource affected by the operation.
GCP.Compute.Operations.targetLinkStringThe URL of the target resource modified by the operation.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe date and time when the operation resource was created.
GCP.Compute.Operations.startTimeDateThe date and time when the operation started running.
GCP.Compute.Operations.userStringThe user account that performed the operation.

gcp-compute-instances-aggregated-list-by-ip#


Returns an aggregated list of instances across all zones that can be filtered by internal or external IP. Required permission: cloudasset.assets.searchAllResources.

Base Command#

gcp-compute-instances-aggregated-list-by-ip

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
ip_addressThe IP address to search for.Required
match_externalIf true, match against external NAT IPs; otherwise internal NIC IPs. Possible values are: true, false.Optional
limitThe maximum number of results to return. Acceptable values are 0 to 500, inclusive. Default is 50.Optional
page_tokenThe token for pagination.Optional

Context Output#

PathTypeDescription
GCP.Compute.Instances.namestringInstance name.
GCP.Compute.Instances.idstringInstance ID.
GCP.Compute.Instances.zonestringInstance zone URL.
GCP.Compute.Instances.statusstringInstance status.
GCP.Compute.Instances.networkInterfacesUnknownNetwork interfaces of the instance.
GCP.Compute.AggregatedByIPInstancesNextTokenstringThis token allows you to get the next page of results for list requests. If the number of results is larger than limit, use the next_token as a value for the query parameter page_token in the next list request.

gcp-compute-network-tag-set#


Adds a network tag to a VM instance (merges with existing tags). Required permission: compute.instances.setTags.

Base Command#

gcp-compute-network-tag-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneZone of the VM (e.g., us-central1-a).Required
resource_nameInstance name.Required
tagTag to add.Required
tags_fingerprintFingerprint of the previous set of tags for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change tags. To retrieve the fingerprint use the command gcp-compute-instance-get.Required
add_tagIf true, adds the tag to the existing tags; otherwise, overrides them. The default is true. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringOperation ID.
GCP.Compute.Operations.namestringOperation name.
GCP.Compute.Operations.statusstringCurrent operation status (e.g., RUNNING, DONE).
GCP.Compute.Operations.operationTypestringType of operation being performed.
GCP.Compute.Operations.progressnumberOperation progress percentage (0-100).
GCP.Compute.Operations.userstringUser or service account that initiated the operation.
GCP.Compute.Operations.targetLinkstringFull URL of the target resource for this operation.
GCP.Compute.Operations.targetIdstringTarget resource ID.
GCP.Compute.Operations.zonestringZone where the operation is performed.
GCP.Compute.Operations.insertTimestringTime when the operation was inserted.
GCP.Compute.Operations.startTimestringTime when the operation started.
GCP.Compute.Operations.selfLinkstringURL for this operation resource.
GCP.Compute.Operations.kindstringType of the resource (e.g., compute#operation).

gcp-compute-image-get#


Returns a specific image. Required permission: compute.images.get.

Base Command#

gcp-compute-image-get

Input#

Argument NameDescriptionRequired
project_idThe project ID for this request. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
imageName of the image resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Images.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Images.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Images.namestringName of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Images.descriptionstringAn optional description of this resource.
GCP.Compute.Images.sourceTypestringThe type of the image used to create this disk. The default and only value is RAW.
GCP.Compute.Images.rawDiskstringThe parameters of the raw disk image.
GCP.Compute.Images.rawDisk.sourcestringThe full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
GCP.Compute.Images.rawDisk.sha1ChecksumstringAn optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
GCP.Compute.Images.rawDisk.containerTypestringThe format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
GCP.Compute.Images.deprecatedstringThe deprecation status associated with this image.
GCP.Compute.Images.deprecated.statestringThe deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
GCP.Compute.Images.deprecated.replacementstringThe URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
GCP.Compute.Images.deprecated.deprecatedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Images.deprecated.obsoletestringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Images.deprecated.deletedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Images.statusstringThe status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
GCP.Compute.Images.archiveSizeBytesstringSize of the image tar.gz archive stored in Google Cloud Storage (in bytes).
GCP.Compute.Images.diskSizeGbstringSize of the image when restored onto a persistent disk (in GB).
GCP.Compute.Images.sourceDiskstringURL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk , projects/project/zones/zone/disks/disk , zones/zone/disks/disk.
GCP.Compute.Images.sourceDiskIdstringThe ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
GCP.Compute.Images.licensesstringAny applicable license URI.
GCP.Compute.Images.familystringThe name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
GCP.Compute.Images.imageEncryptionKeystringEncrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
GCP.Compute.Images.imageEncryptionKey.rawKeystringSpecifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
GCP.Compute.Images.imageEncryptionKey.kmsKeyNamestringThe name of the encryption key that is stored in Google Cloud KMS.
GCP.Compute.Images.imageEncryptionKey.sha256stringThe RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
GCP.Compute.Images.sourceDiskEncryptionKeystringThe customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
GCP.Compute.Images.sourceDiskEncryptionKey.rawKeystringSpecifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
GCP.Compute.Images.sourceDiskEncryptionKey.kmsKeyNamestringThe name of the encryption key that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceDiskEncryptionKey.sha256stringThe RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
GCP.Compute.Images.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Images.labelsstringLabels to apply to this image. These can be later modified by the setLabels method.
GCP.Compute.Images.labelFingerprintstringA fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
GCP.Compute.Images.guestOsFeaturesstringA list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
GCP.Compute.Images.guestOsFeatures.typestringThe ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
GCP.Compute.Images.licenseCodesstringInteger license codes indicating which licenses are attached to this image.
GCP.Compute.Images.sourceImagestringURL of the source image used to create this image. This can be a full or valid partial URL.
GCP.Compute.Images.sourceImageIdstringThe ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.
GCP.Compute.Images.sourceImageEncryptionKeystringThe customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
GCP.Compute.Images.sourceImageEncryptionKey.rawKeystringSpecifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
GCP.Compute.Images.sourceImageEncryptionKey.kmsKeyNamestringThe name of the encryption key that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceImageEncryptionKey.sha256stringThe RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
GCP.Compute.Images.sourceSnapshotstringURL of the source snapshot used to create this image. This can be a full or valid partial URL.
GCP.Compute.Images.sourceSnapshotIdstringThe ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.
GCP.Compute.Images.sourceSnapshotEncryptionKeystringThe customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
GCP.Compute.Images.sourceSnapshotEncryptionKey.rawKeystringSpecifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
GCP.Compute.Images.sourceSnapshotEncryptionKey.kmsKeyNamestringThe name of the encryption key that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceSnapshotEncryptionKey.sha256stringThe RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
GCP.Compute.Images.kindstringType of the resource. Always compute#image for images.

gcp-compute-instance-group-get#


Returns a specific instance group. Required permission: compute.instanceGroups.get.

Base Command#

gcp-compute-instance-group-get

Input#

Argument NameDescriptionRequired
instance_groupThe name of the instance group.Required
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required

Context Output#

PathTypeDescription
GCP.Compute.InstanceGroups.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.InstanceGroups.creationTimestampstringThe creation timestamp for this instance group in RFC3339 text format.
GCP.Compute.InstanceGroups.namestringThe name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
GCP.Compute.InstanceGroups.descriptionstringAn optional description of this resource.
GCP.Compute.InstanceGroups.namedPortsstringAssigns a name to a port number.
GCP.Compute.InstanceGroups.namedPorts.namestringThe name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
GCP.Compute.InstanceGroups.namedPorts.portstringThe port number, which can be a value between 1 and 65535.
GCP.Compute.InstanceGroups.networkstringThe URL of the network to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.fingerprintstringThe fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
GCP.Compute.InstanceGroups.zonestringThe URL of the zone where the instance group is located (for zonal resources).
GCP.Compute.InstanceGroups.selfLinkstringThe URL for this instance group. The server generates this URL.
GCP.Compute.InstanceGroups.sizestringThe total number of instances in the instance group.
GCP.Compute.InstanceGroups.regionstringThe URL of the region where the instance group is located (for regional resources).
GCP.Compute.InstanceGroups.subnetworkstringThe URL of the subnetwork to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.kindstringThe resource type, which is always compute#instance_group for instance groups.

gcp-compute-region-get#


Returns a specific region resource. Required permission: compute.regions.get.

Base Command#

gcp-compute-region-get

Input#

Argument NameDescriptionRequired
regionName of the region resource to return.Required
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional

Context Output#

PathTypeDescription
GCP.Compute.Regions.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Regions.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Regions.namestringName of the resource.
GCP.Compute.Regions.descriptionstringTextual description of the resource.
GCP.Compute.Regions.statusstringStatus of the region, either UP or DOWN.
GCP.Compute.Regions.zonesstringA list of zones available in this region, in the form of resource URLs.
GCP.Compute.Regions.quotasstringQuotas assigned to this region.
GCP.Compute.Regions.quotas.metricstringName of the quota metric.
GCP.Compute.Regions.quotas.limitstringQuota limit for this metric.
GCP.Compute.Regions.quotas.usagestringCurrent usage of this metric.
GCP.Compute.Regions.quotas.ownerstringOwning resource. The resource to which this quota applies.
GCP.Compute.Regions.deprecatedstringThe deprecation status associated with this region.
GCP.Compute.Regions.deprecated.statestringThe deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
GCP.Compute.Regions.deprecated.replacementstringThe URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
GCP.Compute.Regions.deprecated.deprecatedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.deprecated.obsoletestringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.deprecated.deletedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Regions.kindstringType of the resource. Always compute#region for regions.

gcp-compute-regions-list#


Retrieves the list of region resources available to the specified project. Required permission: compute.regions.list.

Base Command#

gcp-compute-regions-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results per page to return, ranging from 1 to 500. If the number of available results is larger than the limit, a token is returned in the nextPageToken field to retrieve the next page of results in subsequent list requests. Default is 50.Optional
filterThe filter expression to use for filtering resources listed in the response. Must specify the field name, a comparison operator, and the filtering value. The value can be a string, a number, or a boolean. The comparison operator must be "=", "!=", ">", or "<". For example, to exclude a region named "example-region", specify name != example-region.Optional
order_byThe order in which to sort the list results. Can be "alphanumerical" (default, based on the resource name) or "creationTimestamp desc" (reverse chronological order, latest result first).Optional
next_tokenThe page token to use. Set next_token to the nextPageToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.Regions.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Regions.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56.000-07:00).
GCP.Compute.Regions.namestringThe name of the resource.
GCP.Compute.Regions.descriptionstringThe textual description of the resource.
GCP.Compute.Regions.statusstringThe status of the region, either UP or DOWN.
GCP.Compute.Regions.zonesstringThe list of zones available in this region, in the form of resource URLs.
GCP.Compute.Regions.quotasstringThe quotas assigned to this region.
GCP.Compute.Regions.quotas.metricstringThe name of the quota metric.
GCP.Compute.Regions.quotas.limitnumberThe quota limit for this metric.
GCP.Compute.Regions.quotas.usagenumberThe current usage of this metric.
GCP.Compute.Regions.quotas.ownerstringThe resource to which this quota applies.
GCP.Compute.Regions.deprecatedstringThe deprecation status associated with this region.
GCP.Compute.Regions.deprecated.statestringThe deprecation state of this resource. Can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
GCP.Compute.Regions.deprecated.replacementstringThe URL of the suggested replacement for a deprecated resource. The replacement resource must be the same type of resource as the deprecated resource.
GCP.Compute.Regions.deprecated.deprecatedstringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.deprecated.obsoletestringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.deprecated.deletedstringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Regions.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Regions.supportsPzsbooleanWhether the region supports physical zone separation. Reserved for future use.
GCP.Compute.Regions.quotaStatusWarningstringThe warning raised while fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.
GCP.Compute.Regions.quotaStatusWarning.codestringThe warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
GCP.Compute.Regions.quotaStatusWarning.messagestringThe human-readable description of the warning code.
GCP.Compute.Regions.quotaStatusWarning.datastringThe metadata about this warning, in key-value format.
GCP.Compute.Regions.kindstringThe type of the resource. Always compute#region for regions.
GCP.Compute.RegionsNextTokenstringThe next page token to use for retrieving the next page of regions.

Command example#

!gcp-compute-regions-list project_id=project-id limit=2

Context Example#

{
"GCP": {
"Compute": {
"Regions": [
{
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"id": "1220",
"kind": "compute#region",
"name": "us-central1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/project-id/regions/us-central1",
"status": "UP",
"zones": [
"https://www.googleapis.com/compute/v1/projects/project-id/zones/us-central1-a",
"https://www.googleapis.com/compute/v1/projects/project-id/zones/us-central1-b"
]
},
{
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"id": "1230",
"kind": "compute#region",
"name": "us-east1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/project-id/regions/us-east1",
"status": "UP",
"zones": [
"https://www.googleapis.com/compute/v1/projects/project-id/zones/us-east1-b"
]
}
],
"RegionsNextToken": "CAIQAA=="
}
}
}

Human Readable Output#

GCP Compute Regions#

IdNameStatusCreation Timestamp
1220us-central1UP1969-12-31T16:00:00.000-08:00
1230us-east1UP1969-12-31T16:00:00.000-08:00

gcp-compute-zone-get#


Returns a specific zone resource. Required permission: compute.zones.get.

Base Command#

gcp-compute-zone-get

Input#

Argument NameDescriptionRequired
zoneName of the zone resource to return.Required
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional

Context Output#

PathTypeDescription
GCP.Compute.Zones.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Zones.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Zones.namestringName of the resource.
GCP.Compute.Zones.descriptionstringTextual description of the resource.
GCP.Compute.Zones.statusstringStatus of the zone, either UP or DOWN.
GCP.Compute.Zones.deprecatedstringThe deprecation status associated with this zone.
GCP.Compute.Zones.deprecated.statestringThe deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
GCP.Compute.Zones.deprecated.replacementstringThe URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
GCP.Compute.Zones.deprecated.deprecatedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.deprecated.obsoletestringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.deprecated.deletedstringAn optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.regionstringFull URL reference to the region which hosts the zone.
GCP.Compute.Zones.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Zones.availableCpuPlatformsstringAvailable cpu/platform selections for the zone. Do not use field = 7 or field = 11. Next available field = 14.
GCP.Compute.Zones.kindstringType of the resource. Always compute#zone for zones.

gcp-compute-zones-list#


Retrieves the list of zone resources available to the specified project. Required permission: compute.zones.list.

Base Command#

gcp-compute-zones-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results per page to return, ranging from 1 to 500. If the number of available results is larger than the limit, a token is returned in the nextPageToken field to retrieve the next page of results in subsequent list requests. Default is 50.Optional
filterThe filter expression to use for filtering resources listed in the response. Must specify the field name, a comparison operator, and the filtering value. The value can be a string, a number, or a boolean. The comparison operator must be "=", "!=", ">", or "<". For example, to exclude a zone named "example-zone", specify name != example-zone.Optional
order_byThe order in which to sort the list results. Can be "alphanumerical" (default, based on the resource name) or "creationTimestamp desc" (reverse chronological order, latest result first).Optional
next_tokenThe page token to use. Set next_token to the nextPageToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.Zones.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Zones.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56.000-07:00).
GCP.Compute.Zones.namestringThe name of the resource.
GCP.Compute.Zones.descriptionstringThe textual description of the resource.
GCP.Compute.Zones.statusstringThe status of the zone, either UP or DOWN.
GCP.Compute.Zones.deprecatedstringThe deprecation status associated with this zone.
GCP.Compute.Zones.deprecated.statestringThe deprecation state of this resource. Can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
GCP.Compute.Zones.deprecated.replacementstringThe URL of the suggested replacement for a deprecated resource. The replacement resource must be the same type of resource as the deprecated resource.
GCP.Compute.Zones.deprecated.deprecatedstringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.deprecated.obsoletestringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.deprecated.deletedstringThe optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED (for example, 2024-01-15T12:34:56.000-07:00). This is only informational and the status will not change unless the client explicitly changes it.
GCP.Compute.Zones.regionstringThe full URL reference to the region which hosts the zone.
GCP.Compute.Zones.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Zones.availableCpuPlatformsstringThe available CPU platform selections for the zone.
GCP.Compute.Zones.supportsPzsbooleanWhether the zone supports physical zone separation. Reserved for future use.
GCP.Compute.Zones.resourceStatusUnknownThe additional status details of the zone.
GCP.Compute.Zones.resourceStatus.upcomingMaintenancesUnknownThe list of upcoming maintenances scheduled for this zone.
GCP.Compute.Zones.kindstringThe type of the resource. Always compute#zone for zones.
GCP.Compute.ZonesNextTokenstringThe next page token to use for retrieving the next page of zones.

Command example#

!gcp-compute-zones-list project_id=project-id limit=2

Context Example#

{
"GCP": {
"Compute": {
"Zones": [
{
"availableCpuPlatforms": [
"Intel Broadwell",
"Intel Cascade Lake"
],
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"id": "2231",
"kind": "compute#zone",
"name": "us-central1-a",
"region": "https://www.googleapis.com/compute/v1/projects/project-id/regions/us-central1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/project-id/zones/us-central1-a",
"status": "UP"
},
{
"availableCpuPlatforms": [
"Intel Broadwell"
],
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"id": "2232",
"kind": "compute#zone",
"name": "us-central1-b",
"region": "https://www.googleapis.com/compute/v1/projects/project-id/regions/us-central1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/project-id/zones/us-central1-b",
"status": "UP"
}
],
"ZonesNextToken": "CAIQAA=="
}
}
}

Human Readable Output#

GCP Compute Zones#

IdNameStatusRegionCreation Timestamp
2231us-central1-aUPhttps://www.googleapis.com/compute/v1/projects/project-id/regions/us-central11969-12-31T16:00:00.000-08:00
2232us-central1-bUPhttps://www.googleapis.com/compute/v1/projects/project-id/regions/us-central11969-12-31T16:00:00.000-08:00

gcp-compute-zone-operation-wait#


Polls a zonal Compute Engine operation until it reaches the DONE status. Required permission: compute.zoneOperations.get.

Base Command#

gcp-compute-zone-operation-wait

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
operation_nameThe name of the Operation resource to wait for.Required
interval_in_secondsThe interval, in seconds, between polling attempts. Must be a positive number. Default is 30.Optional
polling_timeoutThe timeout, in seconds, until polling ends. Must be a positive number. Default is 600.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId field provided when the operation was created.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.error.errorsunknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codestringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messagestringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataunknownThe metadata about this warning, in key: value format.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP status code returned if the operation fails. For example, 404 indicates that the resource is not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.operationGroupIdstringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-region-operation-wait#


Polls a regional Compute Engine operation until it reaches the DONE status. Required permission: compute.regionOperations.get.

Base Command#

gcp-compute-region-operation-wait

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
operation_nameThe name of the Operation resource to wait for.Required
interval_in_secondsThe interval, in seconds, between polling attempts. Must be a positive number. Default is 30.Optional
polling_timeoutThe timeout, in seconds, until polling ends. Must be a positive number. Default is 600.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId field provided when the operation was created.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.error.errorsunknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codestringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messagestringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataunknownThe metadata about this warning, in key: value format.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP status code returned if the operation fails. For example, 404 indicates that the resource is not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.operationGroupIdstringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-global-operation-wait#


Polls a global Compute Engine operation until it reaches the DONE status. Required permission: compute.globalOperations.get.

Base Command#

gcp-compute-global-operation-wait

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
operation_nameThe name of the Operation resource to wait for.Required
interval_in_secondsThe interval, in seconds, between polling attempts. Must be a positive number. Default is 30.Optional
polling_timeoutThe timeout, in seconds, until polling ends. Must be a positive number. Default is 600.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId field provided when the operation was created.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.error.errorsunknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codestringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messagestringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataunknownThe metadata about this warning, in key: value format.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP status code returned if the operation fails. For example, 404 indicates that the resource is not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.operationGroupIdstringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-networks-list#


Retrieves a list of networks available for the specified project. Required permission: compute.networks.list.

Base Command#

gcp-compute-networks-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results per page that should be returned. If the number of available results is larger than limit, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 50, inclusive. Default is 50.Optional
filtersA filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.Optional
order_bySorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using order_by="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.Optional
page_tokenSpecifies a page token to use. Set page_token to the nextPageToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.Networks.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Networks.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Networks.namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Networks.descriptionstringAn optional description of this resource.
GCP.Compute.Networks.gatewayIPv4stringThe gateway address for default routing out of the network. This value is read only and is selected by GCP.
GCP.Compute.Networks.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Networks.autoCreateSubnetworksbooleanWhen set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode.
GCP.Compute.Networks.subnetworksstringServer-defined fully-qualified URLs for all subnetworks in this VPC network.
GCP.Compute.Networks.peeringsstringA list of network peerings for the resource.
GCP.Compute.Networks.peerings.namestringName of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Networks.peerings.networkstringThe URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
GCP.Compute.Networks.peerings.statestringState for the peering.
GCP.Compute.Networks.peerings.stateDetailsstringDetails about the current state of the peering.
GCP.Compute.Networks.peerings.autoCreateRoutesbooleanThis field will be deprecated soon. Prefer using exchangeSubnetRoutes instead. Indicates whether full mesh connectivity is created and managed automatically. When set to true, Google Compute Engine automatically creates and manages the routes between two networks while the state is ACTIVE. If set to false, the user must manually create routes to direct packets to the peer network.
GCP.Compute.Networks.peerings.exchangeSubnetRoutesbooleanWhether full mesh connectivity is created and managed automatically. When set to true, Google Compute Engine automatically creates and manages the routes between two networks while the peering state is ACTIVE. If set to false, the user must manually create routes to send packets to the peer network.
GCP.Compute.Networks.routingConfigstringThe network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
GCP.Compute.Networks.routingConfig.routingModestringSpecifies the network-wide routing mode. If set to REGIONAL, the network’s cloud routers advertise routes only for subnets in the same region as the router. If set to GLOBAL, cloud routers advertise routes for all subnets in the network across all regions.
GCP.Compute.Networks.kindstringType of the resource. Always compute#network for networks.

gcp-compute-network-insert#


Creates a network in the specified project using the data included in the request. Required permission: compute.networks.create.

Base Command#

gcp-compute-network-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
nameName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.Required
descriptionAn optional description of this resource.Optional
auto_create_sub_networksWhen set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. Possible values are: true, false.Optional
routing_config_routing_modeThe network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. Possible values are: REGIONAL, GLOBAL.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Operations.namestringName of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if you provided it in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringUser who requested the operation for example EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format.
GCP.Compute.Operations.errorstringIf errors are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.error.errorsstringThe array of errors encountered while processing this operation.
GCP.Compute.Operations.error.errorsstringThe error type identifier for this error.
GCP.Compute.Operations.error.errorsstringIndicates the field in the request that caused the error. This property is optional.
GCP.Compute.Operations.error.errorsstringAn optional, human-readable error message.
GCP.Compute.Operations.warningsstringIf warning messages are generated during processing of the operation, this field will be populated.
GCP.Compute.Operations.warnings.codestringA warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
GCP.Compute.Operations.warnings.messagestringA human-readable description of the warning code.
GCP.Compute.Operations.warnings.datastringMetadata about this warning in key: value format.
GCP.Compute.Operations.warnings.datastringA key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
GCP.Compute.Operations.warnings.datastringA warning data value corresponding to the key.
GCP.Compute.Operations.httpErrorStatusCodenumberIf the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringIf the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-network-get#


Returns the specified network.

Base Command#

gcp-compute-network-get

Input#

Argument NameDescriptionRequired
networkName of the network to return.Required
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional

Context Output#

PathTypeDescription
GCP.Compute.Networks.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.Networks.creationTimestampstringCreation timestamp in RFC3339 text format.
GCP.Compute.Networks.namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Networks.descriptionstringAn optional description of this resource.
GCP.Compute.Networks.gatewayIPv4stringThe gateway address for default routing out of the network. This value is read only and is selected by GCP.
GCP.Compute.Networks.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Networks.autoCreateSubnetworksbooleanWhen set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode.
GCP.Compute.Networks.subnetworksstringServer-defined fully-qualified URLs for all subnetworks in this VPC network.
GCP.Compute.Networks.peeringsstringA list of network peerings for the resource.
GCP.Compute.Networks.peerings.namestringName of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
GCP.Compute.Networks.peerings.networkstringThe URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
GCP.Compute.Networks.peerings.statestringState for the peering.
GCP.Compute.Networks.peerings.stateDetailsstringDetails about the current state of the peering.
GCP.Compute.Networks.peerings.autoCreateRoutesbooleanThis field will be deprecated soon. Prefer using exchangeSubnetRoutes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network.
GCP.Compute.Networks.peerings.exchangeSubnetRoutesbooleanWhether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network.
GCP.Compute.Networks.routingConfigstringThe network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
GCP.Compute.Networks.routingConfig.routingModestringThe network-wide routing mode to use. If set to REGIONAL, this networks cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this networks cloud routers will advertise routes with all subnets of this network, across regions.
GCP.Compute.Networks.kindstringType of the resource. Always compute#network for networks.

gcp-compute-firewall-insert#


Creates a new firewall rule in a specific project. Required permission: compute.firewalls.create.

Base Command#

gcp-compute-firewall-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameName of the firewall rule to create.Required
descriptionAn optional description for the firewall rule.Optional
networkURL of the network, e.g., global/networks/default.Optional
priorityPriority 0-65535. Default 1000.Optional
directionDirection of traffic to which this firewall applies. Default INGRESS. Possible values are: INGRESS, EGRESS. Default is INGRESS.Optional
allowedALLOW rules in tuples, e.g., ipprotocol=tcp,ports=443;ipprotocol=tcp,ports=80.Optional
deniedDENY rules in tuples, e.g., ipprotocol=tcp,ports=22,443.Optional
source_rangesComma-separated CIDRs for INGRESS.Optional
destination_rangesComma-separated CIDRs for EGRESS.Optional
source_tagsComma-separated instance tags to match as source.Optional
target_tagsComma-separated tags to apply this rule to.Optional
source_service_accountsComma-separated service accounts for source.Optional
target_service_accountsComma-separated service accounts to target.Optional
log_config_enableEnable firewall logging. Possible values are: true, false.Optional
disabledWhether this firewall rule is disabled. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringUnique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringName of the operation resource.
GCP.Compute.Operations.kindStringType of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringType of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringCurrent status of the operation.
GCP.Compute.Operations.progressNumberProgress of the operation as a percentage between 0 and 100.
GCP.Compute.Operations.targetIdStringUnique target ID of the resource affected by the operation.
GCP.Compute.Operations.targetLinkStringURL of the target resource modified by the operation.
GCP.Compute.Operations.selfLinkStringServer-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time when the operation resource was created.
GCP.Compute.Operations.startTimeDateThe time when the operation started running.
GCP.Compute.Operations.userStringThe user account that performed the operation.

gcp-compute-firewall-list#


Lists the firewall rules in a specific project. The command is deprecated, please use gcp-compute-firewalls-list. Required permission: compute.firewalls.list.

Base Command#

gcp-compute-firewall-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitMaximum number of results to return. Acceptable values are 0 to 500, inclusive. Default is 50.Optional
page_tokenToken for pagination.Optional
filterA filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a Compute Engine instance named example-instance, use name != example-instance.
For more options and details, see:
https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/list#:~:text=page%20of%20results.-,filter,-string.
Optional

Context Output#

PathTypeDescription
GCP.Compute.Firewall.idStringUnique identifier for the firewall rule.
GCP.Compute.Firewall.nameStringName of the firewall rule.
GCP.Compute.Firewall.kindStringType of the resource (for example, compute#firewall).
GCP.Compute.Firewall.descriptionStringDescription of the firewall rule.
GCP.Compute.Firewall.directionStringDirection of traffic for the rule (INGRESS or EGRESS).
GCP.Compute.Firewall.disabledBooleanIndicates whether the firewall rule is disabled.
GCP.Compute.Firewall.priorityNumberPriority value of the firewall rule.
GCP.Compute.Firewall.networkStringThe network URL this firewall rule applies to.
GCP.Compute.Firewall.selfLinkStringServer-defined URL for the resource.
GCP.Compute.Firewall.creationTimestampDateThe creation timestamp of the firewall rule.
GCP.Compute.Firewall.logConfig.enableBooleanIndicates whether logging is enabled for the firewall rule.
GCP.Compute.Firewall.sourceRangesUnknownList of source IP ranges that the rule applies to.
GCP.Compute.Firewall.targetTagsUnknownList of target instance tags to which the rule applies.
GCP.Compute.FirewallNextTokenStringNext page token for pagination.

gcp-compute-firewall-get#


Retrieves a specific firewall rule by name. Required permission: compute.firewalls.get.

Base Command#

gcp-compute-firewall-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameFirewall rule name.Required

Context Output#

PathTypeDescription
GCP.Compute.Firewalls.namestringFirewall rule name.
GCP.Compute.Firewalls.networkstringNetwork URL for the firewall rule.
GCP.Compute.Firewalls.directionstringDirection of traffic (INGRESS/EGRESS).
GCP.Compute.Firewalls.prioritynumberPriority of the rule.
GCP.Compute.Firewalls.allowedUnknownAllowed tuples.
GCP.Compute.Firewalls.deniedUnknownDenied tuples.
GCP.Compute.Firewalls.targetTagsUnknownTarget instance tags.

gcp-compute-firewall-delete#


Deletes the specified firewall rule. Required permission: compute.firewalls.delete.

Base Command#

gcp-compute-firewall-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
resource_nameThe name of the firewall rule to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe current status of the operation.
GCP.Compute.Operations.progressNumberThe progress of the operation as a percentage between 0 and 100.
GCP.Compute.Operations.targetIdStringThe unique target ID of the resource affected by the operation.
GCP.Compute.Operations.targetLinkStringThe URL of the target resource modified by the operation.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe date and time when the operation resource was created.
GCP.Compute.Operations.startTimeDateThe date and time when the operation started running.
GCP.Compute.Operations.userStringThe user account that performed the operation.

gcp-compute-snapshots-list#


Lists snapshots in a specific project. Required permission: compute.snapshots.list.

Base Command#

gcp-compute-snapshots-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return. Acceptable values are 0 to 500, inclusive. Default is 50.Optional
page_tokenThe token for pagination.Optional
filterA filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a Compute Engine instance named example-instance, use name != example-instance.
For more options and details, see:
https://cloud.google.com/compute/docs/reference/rest/v1/snapshots/list#:~:text=page%20of%20results.-,filter,-string.
Optional

Context Output#

PathTypeDescription
GCP.Compute.Snapshots.idStringUnique identifier for the snapshot resource.
GCP.Compute.Snapshots.nameStringName of the snapshot resource.
GCP.Compute.Snapshots.kindStringType of the resource, for example compute#snapshot.
GCP.Compute.Snapshots.statusStringCurrent status of the snapshot, such as READY or FAILED.
GCP.Compute.Snapshots.autoCreatedBooleanIndicates whether the snapshot was automatically created.
GCP.Compute.Snapshots.architectureStringCPU architecture of the source disk, for example X86_64.
GCP.Compute.Snapshots.creationTimestampDateThe time when the snapshot was created.
GCP.Compute.Snapshots.creationSizeBytesNumberTotal size of the snapshot in bytes at creation time.
GCP.Compute.Snapshots.diskSizeGbNumberSize of the snapshot in gigabytes.
GCP.Compute.Snapshots.downloadBytesNumberTotal bytes downloaded to create the snapshot.
GCP.Compute.Snapshots.enableConfidentialComputeBooleanIndicates if confidential compute is enabled for this snapshot.
GCP.Compute.Snapshots.labelFingerprintStringFingerprint for the labels applied to the snapshot.
GCP.Compute.Snapshots.licenseCodesUnknownList of license code identifiers attached to the snapshot.
GCP.Compute.Snapshots.licensesUnknownList of license URLs associated with the snapshot.
GCP.Compute.Snapshots.selfLinkStringServer-defined URL for the snapshot resource.
GCP.Compute.Snapshots.sourceDiskStringURL of the source disk used to create the snapshot.
GCP.Compute.Snapshots.sourceDiskIdStringUnique ID of the source disk used to create the snapshot.
GCP.Compute.Snapshots.sourceSnapshotSchedulePolicyStringURL of the snapshot schedule policy used to create this snapshot.
GCP.Compute.Snapshots.sourceSnapshotSchedulePolicyIdStringUnique ID of the snapshot schedule policy used to create this snapshot.
GCP.Compute.Snapshots.storageBytesNumberTotal storage size of the snapshot in bytes.
GCP.Compute.Snapshots.storageBytesStatusStringStatus of the storage bytes usage, for example UP_TO_DATE.
GCP.Compute.Snapshots.storageLocationsUnknownList of storage locations for the snapshot.
GCP.Compute.SnapshotsNextTokenStringNext page token for pagination.

gcp-bq-dataset-policy-remove#


Removes an email from the BigQuery dataset policy. Required Permissions: bigquery.datasets.update, bigquery.datasets.get, bigquery.datasets.getIamPolicy, bigquery.datasets.setIamPolicy.

Base Command#

gcp-bq-dataset-policy-remove

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
dataset_idThe dataset ID of the requested dataset.Required
emailThe email address to remove from the dataset access list.Required

Context Output#

PathTypeDescription
GCP.BigQuery.Datasets.kindStringThe resource type.
GCP.BigQuery.Datasets.etagStringA hash of the resource.
GCP.BigQuery.Datasets.idStringThe fully-qualified unique name of the dataset in the format projectId:datasetId.
GCP.BigQuery.Datasets.selfLinkStringA URL that can be used to access the resource again.
GCP.BigQuery.Datasets.datasetReferenceUnknownA reference that identifies the dataset.
GCP.BigQuery.Datasets.friendlyNameStringA descriptive name for the dataset.
GCP.BigQuery.Datasets.descriptionStringA user-friendly description of the dataset.
GCP.BigQuery.Datasets.defaultTableExpirationMsStringThe default lifetime of all tables in the dataset, in milliseconds.
GCP.BigQuery.Datasets.defaultPartitionExpirationMsStringThe default partition expiration, in milliseconds.
GCP.BigQuery.Datasets.labelsStringThe labels associated with this dataset.
GCP.BigQuery.Datasets.access.roleStringThe role assigned to the entity.
GCP.BigQuery.Datasets.access.userByEmailStringAn email address of a user to grant access to.
GCP.BigQuery.Datasets.access.groupByEmailStringAn email address of a group to grant access to.
GCP.BigQuery.Datasets.access.domainStringA domain to grant access to.
GCP.BigQuery.Datasets.access.specialGroupStringA special group to grant access to.
GCP.BigQuery.Datasets.access.iamMemberStringA type of member that appears in the IAM Policy that isn't a user, group, domain, or special group.
GCP.BigQuery.Datasets.access.viewUnknownA view from a different dataset to grant access to.
GCP.BigQuery.Datasets.access.routineUnknownA routine from a different dataset to grant access to.
GCP.BigQuery.Datasets.access.datasetUnknownA grant authorizing access to this dataset for all resources of a particular type.
GCP.BigQuery.Datasets.access.conditionUnknownThe binding condition.
GCP.BigQuery.Datasets.creationTimeStringThe time since the epoch the dataset was created, in milliseconds.
GCP.BigQuery.Datasets.lastModifiedTimeStringThe time since the epoch the dataset was last modified, in milliseconds.
GCP.BigQuery.Datasets.locationStringThe geographic location where the dataset resides.
GCP.BigQuery.Datasets.defaultEncryptionConfigurationStringThe default encryption configuration for all tables in the dataset.
GCP.BigQuery.Datasets.typeStringThe type of the dataset.
GCP.BigQuery.Datasets.linkedDatasetSourceUnknownThe source dataset reference when the dataset is of type LINKED.
GCP.BigQuery.Datasets.linkedDatasetMetadataUnknownMetadata about the LinkedDataset.
GCP.BigQuery.Datasets.externalDatasetReferenceUnknownReference to a read-only external dataset defined in data catalogs outside of BigQuery.
GCP.BigQuery.Datasets.externalCatalogDatasetOptionsUnknownOptions defining open source compatible datasets in the BigQuery catalog. Contains metadata of the open source database, schema, or namespace of the current dataset.
GCP.BigQuery.Datasets.isCaseInsensitiveStringTrue if the dataset and its table names are case-insensitive.
GCP.BigQuery.Datasets.defaultCollationStringThe default collation specification of future tables created in the dataset.
GCP.BigQuery.Datasets.defaultRoundingModeStringThe default rounding mode specification of new tables created within this dataset.
GCP.BigQuery.Datasets.maxTimeTravelHoursStringThe time travel window in hours.
GCP.BigQuery.Datasets.resourceTagsStringThe tags attached to this dataset.
GCP.BigQuery.Datasets.storageBillingModelStringThe billing model that will be applied to the dataset.
GCP.BigQuery.Datasets.catalogSourceStringThe origin of the dataset.

gcp-compute-firewalls-list#


Lists the firewall rules in a specific project. Required permission: compute.firewalls.list.

Base Command#

gcp-compute-firewalls-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return. Acceptable values are 0 to 500, inclusive. Default is 50.Optional
page_tokenThe token for pagination.Optional
filterA filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a Compute Engine instance named example-instance, use name != example-instance.
For more options and details, see:
https://cloud.google.com/compute/docs/reference/rest/v1/firewalls/list#:~:text=page%20of%20results.-,filter,-string.
Optional

Context Output#

PathTypeDescription
GCP.Compute.Firewalls.idStringThe unique identifier for the firewall rule.
GCP.Compute.Firewalls.nameStringName of the firewall rule.
GCP.Compute.Firewalls.kindStringType of the resource (for example, compute#firewall).
GCP.Compute.Firewalls.descriptionStringDescription of the firewall rule.
GCP.Compute.Firewalls.directionStringDirection of traffic for the rule (INGRESS or EGRESS).
GCP.Compute.Firewalls.disabledBooleanIndicates whether the firewall rule is disabled.
GCP.Compute.Firewalls.priorityNumberPriority value of the firewall rule.
GCP.Compute.Firewalls.networkStringThe network URL this firewall rule applies to.
GCP.Compute.Firewalls.selfLinkStringServer-defined URL for the resource.
GCP.Compute.Firewalls.creationTimestampDateThe creation timestamp of the firewall rule in ISO 8601 format (e.g., 2024-01-15T12:34:56Z).
GCP.Compute.Firewalls.logConfig.enableBooleanIndicates whether logging is enabled for the firewall rule.
GCP.Compute.Firewalls.sourceRangesUnknownList of source IP ranges that the rule applies to.
GCP.Compute.Firewalls.targetTagsUnknownList of target instance tags to which the rule applies.
GCP.Compute.FirewallsNextTokenStringNext page token for pagination.

gcp-storage-buckets-list#


Retrieves the list of buckets in the project associated with the client. Required permission: storage.buckets.list.

Base Command#

gcp-storage-buckets-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitMaximum number of buckets to return.Optional
prefixFilter results to buckets whose names begin with this prefix.Optional
page_tokenThe token for pagination.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.idStringThe unique identifier for the bucket.
GCP.Storage.Buckets.nameStringThe name of the bucket.
GCP.Storage.Buckets.kindStringThe type of resource (for example, storage#bucket).
GCP.Storage.Buckets.locationStringThe location of the bucket.
GCP.Storage.Buckets.locationTypeStringThe type of location (for example, multi-region).
GCP.Storage.Buckets.projectNumberStringThe GCP project number associated with the bucket.
GCP.Storage.Buckets.storageClassStringThe storage class of the bucket.
GCP.Storage.Buckets.rpoStringThe recovery point objective setting of the bucket.
GCP.Storage.Buckets.etagStringThe HTTP entity tag of the bucket.
GCP.Storage.Buckets.generationStringThe generation number of the bucket.
GCP.Storage.Buckets.metagenerationStringThe metageneration number of the bucket.
GCP.Storage.Buckets.timeCreatedDateThe time the bucket was created.
GCP.Storage.Buckets.timeUpdatedDateThe time the bucket was last updated.
GCP.Storage.Buckets.selfLinkStringThe link to the bucket resource on the GCP API.
GCP.Storage.BucketsNextTokenStringThe continuation token. Provide this value as the page_token of a subsequent request in order to return the next page of results.

gcp-storage-bucket-policies-list#


Retrieves the IAM policy for a bucket. Required permissions: storage.buckets.getIamPolicy, storage.buckets.get.

Base Command#

gcp-storage-bucket-policies-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket to retrieve IAM policy from.Required
requested_policy_versionThe IAM policy version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails. Required to be 3 or greater for buckets with IAM Conditions.Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketPolicies.versionNumberIAM policy version.
GCP.Storage.BucketPolicies.etagStringETag of the IAM policy.
GCP.Storage.BucketPolicies.bindingsUnknownList of role bindings for the bucket.
GCP.Storage.BucketPolicies.resourceIdStringResource ID of the updated IAM policy. e.g. projects/_/buckets/BUCKET_NAME.

gcp-storage-bucket-object-policies-list#


Retrieves the IAM policy for a specific object in a bucket. Required permission: storage.objects.getIamPolicy.

Base Command#

gcp-storage-bucket-object-policies-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket containing the object.Required
object_nameName of the object to retrieve IAM policy from.Required
generationThe generation of the object (e.g., a positive integer).Optional

Context Output#

PathTypeDescription
GCP.Storage.BucketObjectPolicies.bucketNameStringThe name of the bucket containing the object.
GCP.Storage.BucketObjectPolicies.objectNameStringName of the object.
GCP.Storage.BucketObjectPolicies.bindingsUnknownList of role bindings for the object.

gcp-gke-cluster-security-update#


Configures security settings for GKE clusters, including access controls and visibility. Only one update may be applied to a cluster per request. Provide exactly one of the supported security flags. Required permissions: container.clusters.update, container.clusters.get, container.clusters.list.

Base Command#

gcp-gke-cluster-security-update

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe GCP region.Required
resource_nameName of the GKE cluster.Required
enable_intra_node_visibilityWhether to enable intra-node visibility. Possible values are: true, false.Optional
enable_master_authorized_networksWhether to enable Master Authorized Networks. Possible values are: true, false.Optional
cidrsA comma-separated list of up to 50 CIDR blocks (for example, "192.168.0.0/24,10.0.0.0/32") that are allowed to access the Kubernetes master via HTTPS.
If enable_master_authorized_networks is true and no CIDRs are provided, all access will be blocked.
.
Optional
enable_binary_authorizationWhether to enable Binary Authorization on the cluster. Possible values are: true, false.Optional
enable_http_load_balancingWhether to enable the HTTP load balancing add-on on the cluster. Possible values are: true, false.Optional
enable_kubernetes_dashboardWhether to enable the Kubernetes dashboard add-on on the cluster. Possible values are: true, false.Optional
enable_network_policyWhether to enable the network policy add-on on the cluster. Possible values are: true, false.Optional
enable_stackdriver_kubernetesWhether to enable Stackdriver Kubernetes monitoring and logging on the cluster. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.GKE.Operations.nameStringThe name of the GKE cluster.
GCP.GKE.Operations.zoneStringThe zone of the GKE cluster.
GCP.GKE.Operations.enableStackdriverLoggingBooleanWhether Stackdriver Logging is enabled for the cluster.
GCP.GKE.Operations.enableStackdriverMonitoringBooleanWhether Stackdriver Monitoring is enabled for the cluster.
GCP.GKE.Operations.enablePrivateNodesBooleanWhether private nodes are enabled for the GKE cluster.
GCP.GKE.Operations.enablePrivateEndpointBooleanWhether private endpoint is enabled for the GKE cluster control plane.
GCP.GKE.Operations.enableHttpsOnlyBooleanWhether HTTPS-only traffic is enforced for the cluster.
GCP.GKE.Operations.enableNetworkPolicyBooleanWhether network policies are enabled for the cluster.
GCP.GKE.Operations.enableAutoscalingBooleanWhether autoscaling is enabled for the cluster nodes.
GCP.GKE.Operations.enableIstioBooleanWhether Istio is enabled for the GKE cluster.
GCP.GKE.Operations.enablePodSecurityPolicyBooleanWhether PodSecurityPolicy is enabled for the GKE cluster.
GCP.GKE.Operations.enableBinaryAuthorizationBooleanWhether Binary Authorization is enabled for the cluster.
GCP.GKE.Operations.enableLegacyABACBooleanWhether legacy ABAC is enabled for the cluster.
GCP.GKE.Operations.clusterIpv4CidrStringThe cluster’s IPv4 CIDR block.
GCP.GKE.Operations.masterAuthorizedNetworksConfig.cidrBlocksUnknownList of authorized CIDR blocks that can access the GKE cluster master.
GCP.GKE.Operations.masterAuthorizedNetworksConfig.enabledBooleanWhether master authorized networks are enabled for the cluster.
GCP.GKE.Operations.networkStringThe network to which the GKE cluster belongs.
GCP.GKE.Operations.subnetworkStringThe subnetwork to which the GKE cluster belongs.
GCP.GKE.Operations.loggingServiceStringThe logging service used for the cluster (e.g., "logging.googleapis.com").
GCP.GKE.Operations.monitoringServiceStringThe monitoring service used for the cluster (e.g., "monitoring.googleapis.com").
GCP.GKE.Operations.nodePoolsUnknownA list of node pools in the cluster, with their configuration and security settings.
GCP.GKE.Operations.privateClusterConfig.enablePrivateNodesBooleanWhether private nodes are enabled in the cluster.
GCP.GKE.Operations.privateClusterConfig.enablePrivateEndpointBooleanWhether private endpoint is enabled for the cluster control plane.
GCP.GKE.Operations.masterVersionStringThe current version of the Kubernetes master in the GKE cluster.

gcp-storage-bucket-create#


Creates a new Google Cloud Storage (GCS) bucket in the specified project. Required permission: storage.buckets.create.

Base Command#

gcp-storage-bucket-create

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket to create.Required
locationThe location of the bucket (for example, US, EU, ASIA, us-central1). If not provided, the GCS API default (US) is used.Optional
bucket_aclThe predefined ACL to apply to the bucket. Possible values are: authenticatedRead, private, projectPrivate, publicRead, publicReadWrite.Optional
default_object_aclThe predefined default object ACL to apply to objects added to the bucket. Possible values are: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead.Optional
uniform_bucket_level_accessWhether to enable Uniform Bucket-Level Access (UBLA) on the bucket. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.idStringThe unique identifier for the bucket.
GCP.Storage.Buckets.nameStringThe name of the bucket.
GCP.Storage.Buckets.kindStringThe type of resource (for example, storage#bucket).
GCP.Storage.Buckets.selfLinkStringThe link to the bucket resource on the GCP API.
GCP.Storage.Buckets.projectNumberStringThe GCP project number associated with the bucket.
GCP.Storage.Buckets.locationStringThe location of the bucket.
GCP.Storage.Buckets.locationTypeStringThe type of location (for example, multi-region).
GCP.Storage.Buckets.storageClassStringThe storage class of the bucket.
GCP.Storage.Buckets.rpoStringThe recovery point objective setting of the bucket.
GCP.Storage.Buckets.etagStringThe HTTP entity tag of the bucket.
GCP.Storage.Buckets.metagenerationStringThe metageneration number of the bucket.
GCP.Storage.Buckets.timeCreatedDateThe time the bucket was created.
GCP.Storage.Buckets.updatedDateThe time the bucket was last updated.
GCP.Storage.Buckets.iamConfiguration.publicAccessPreventionStringThe public access prevention setting of the bucket.
GCP.Storage.Buckets.iamConfiguration.uniformBucketLevelAccessObjectThe Uniform Bucket-Level Access (UBLA) configuration, including whether it is enabled and the deadline for disabling it.
GCP.Storage.Buckets.versioning.enabledBooleanWhether object versioning is enabled for the bucket.
GCP.Storage.Buckets.defaultEventBasedHoldBooleanThe default value for the event-based hold on newly created objects in the bucket.
GCP.Storage.Buckets.generationStringThe generation (version) number of the bucket.
GCP.Storage.Buckets.softDeleteTimeDateThe date and time when the bucket was soft-deleted.
GCP.Storage.Buckets.hardDeleteTimeDateThe time the bucket will be permanently deleted.
GCP.Storage.Buckets.hierarchicalNamespace.enabledBooleanWhether hierarchical namespace is enabled for the bucket.
GCP.Storage.Buckets.encryption.defaultKmsKeyNameStringThe Cloud KMS key used to encrypt objects written to the bucket when no encryption method is specified.
GCP.Storage.Buckets.aclUnknownThe access controls on the bucket (bucketAccessControls resources). Omitted when Uniform Bucket-Level Access is enabled.
GCP.Storage.Buckets.defaultObjectAclUnknownThe default access controls applied to new objects when no ACL is provided. Omitted when Uniform Bucket-Level Access is enabled.
GCP.Storage.Buckets.website.mainPageSuffixStringThe suffix appended to requests for a directory-like URL, used for static website hosting.
GCP.Storage.Buckets.website.notFoundPageStringThe object served when a requested resource is not found, used for static website hosting.
GCP.Storage.Buckets.owner.entityStringThe entity that owns the bucket, in the form project-owner-projectId.
GCP.Storage.Buckets.owner.entityIdStringThe ID of the entity that owns the bucket.
GCP.Storage.Buckets.logging.logBucketStringThe destination bucket where the bucket's logs are placed.
GCP.Storage.Buckets.logging.logObjectPrefixStringThe prefix for log object names.
GCP.Storage.Buckets.corsUnknownThe bucket's Cross-Origin Resource Sharing (CORS) configuration.
GCP.Storage.Buckets.lifecycle.ruleUnknownThe bucket's lifecycle management rules.
GCP.Storage.Buckets.autoclass.enabledBooleanWhether Autoclass is enabled for the bucket.
GCP.Storage.Buckets.autoclass.toggleTimeDateThe date and time when Autoclass was last enabled or disabled for the bucket.
GCP.Storage.Buckets.autoclass.terminalStorageClassStringThe coldest storage class that an object transitions to in an Autoclass-enabled bucket.
GCP.Storage.Buckets.autoclass.terminalStorageClassUpdateTimeDateThe date and time when the terminal storage class was last updated for the bucket.
GCP.Storage.Buckets.labelsUnknownThe user-provided bucket labels, as key-value pairs.
GCP.Storage.Buckets.retentionPolicy.retentionPeriodStringThe minimum age in seconds that objects must reach before they can be deleted or replaced.
GCP.Storage.Buckets.retentionPolicy.effectiveTimeDateThe date and time from which the retention policy was effective.
GCP.Storage.Buckets.retentionPolicy.isLockedBooleanWhether the retention policy is locked.
GCP.Storage.Buckets.objectRetention.modeStringThe bucket's object retention mode. When enabled, retention configurations can be set on objects.
GCP.Storage.Buckets.billing.requesterPaysBooleanWhether Requester Pays is enabled for the bucket.
GCP.Storage.Buckets.softDeletePolicy.retentionDurationSecondsStringThe period in seconds during which a soft-deleted object is retained and cannot be permanently deleted.
GCP.Storage.Buckets.softDeletePolicy.effectiveTimeDateThe date and time when the soft delete policy becomes effective.
GCP.Storage.Buckets.customPlacementConfig.dataLocationsUnknownThe list of individual regions that comprise a configurable dual-region bucket.
GCP.Storage.Buckets.ipFilter.modeStringThe state of the IP filter configuration (Enabled or Disabled).

gcp-storage-bucket-delete#


Deletes a Google Cloud Storage (GCS) bucket. The bucket must be empty unless the force argument is set to true. Required permissions: storage.buckets.delete, storage.objects.list, storage.objects.delete.

Base Command#

gcp-storage-bucket-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket to delete.Required
forceWhether to delete all objects in the bucket before deleting the bucket itself. When false, deleting a non-empty bucket fails. Possible values are: true, false. Default is false.Optional

Context Output#

There is no context output for this command.

gcp-storage-bucket-public-access-block#


Sets the public access prevention configuration on a GCS bucket. Required permissions: storage.buckets.update, storage.buckets.setIamPolicy.

Base Command#

gcp-storage-bucket-public-access-block

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket.Required
public_access_preventionThe public access prevention setting to apply. "enforced" blocks all public access; "inherited" defers to the organization policy. Possible values are: enforced, inherited. Default is enforced.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.idStringThe unique identifier for the bucket.
GCP.Storage.Buckets.nameStringThe name of the bucket.
GCP.Storage.Buckets.kindStringThe type of resource (for example, storage#bucket).
GCP.Storage.Buckets.selfLinkStringThe link to the bucket resource on the GCP API.
GCP.Storage.Buckets.projectNumberStringThe GCP project number associated with the bucket.
GCP.Storage.Buckets.locationStringThe location of the bucket.
GCP.Storage.Buckets.locationTypeStringThe type of location (for example, multi-region).
GCP.Storage.Buckets.storageClassStringThe storage class of the bucket.
GCP.Storage.Buckets.rpoStringThe recovery point objective setting of the bucket.
GCP.Storage.Buckets.etagStringThe HTTP entity tag of the bucket.
GCP.Storage.Buckets.metagenerationStringThe metageneration number of the bucket.
GCP.Storage.Buckets.timeCreatedDateThe time the bucket was created.
GCP.Storage.Buckets.updatedDateThe time the bucket was last updated.
GCP.Storage.Buckets.iamConfiguration.publicAccessPreventionStringThe public access prevention setting of the bucket.
GCP.Storage.Buckets.iamConfiguration.uniformBucketLevelAccessObjectThe Uniform Bucket-Level Access (UBLA) configuration, including whether it is enabled and the deadline for disabling it.
GCP.Storage.Buckets.versioning.enabledBooleanWhether object versioning is enabled for the bucket.
GCP.Storage.Buckets.defaultEventBasedHoldBooleanThe default value for the event-based hold on newly created objects in the bucket.
GCP.Storage.Buckets.generationStringThe generation (version) number of the bucket.
GCP.Storage.Buckets.softDeleteTimeDateThe date and time when the bucket was soft-deleted.
GCP.Storage.Buckets.hardDeleteTimeDateThe time the bucket will be permanently deleted.
GCP.Storage.Buckets.hierarchicalNamespace.enabledBooleanWhether hierarchical namespace is enabled for the bucket.
GCP.Storage.Buckets.encryption.defaultKmsKeyNameStringThe Cloud KMS key used to encrypt objects written to the bucket when no encryption method is specified.
GCP.Storage.Buckets.aclUnknownThe access controls on the bucket (bucketAccessControls resources). Omitted when Uniform Bucket-Level Access is enabled.
GCP.Storage.Buckets.defaultObjectAclUnknownThe default access controls applied to new objects when no ACL is provided. Omitted when Uniform Bucket-Level Access is enabled.
GCP.Storage.Buckets.website.mainPageSuffixStringThe suffix appended to requests for a directory-like URL, used for static website hosting.
GCP.Storage.Buckets.website.notFoundPageStringThe object served when a requested resource is not found, used for static website hosting.
GCP.Storage.Buckets.owner.entityStringThe entity that owns the bucket, in the form project-owner-projectId.
GCP.Storage.Buckets.owner.entityIdStringThe ID of the entity that owns the bucket.
GCP.Storage.Buckets.logging.logBucketStringThe destination bucket where the bucket's logs are placed.
GCP.Storage.Buckets.logging.logObjectPrefixStringThe prefix for log object names.
GCP.Storage.Buckets.corsUnknownThe bucket's Cross-Origin Resource Sharing (CORS) configuration.
GCP.Storage.Buckets.lifecycle.ruleUnknownThe bucket's lifecycle management rules.
GCP.Storage.Buckets.autoclass.enabledBooleanWhether Autoclass is enabled for the bucket.
GCP.Storage.Buckets.autoclass.toggleTimeDateThe date and time when Autoclass was last enabled or disabled for the bucket.
GCP.Storage.Buckets.autoclass.terminalStorageClassStringThe coldest storage class that an object transitions to in an Autoclass-enabled bucket.
GCP.Storage.Buckets.autoclass.terminalStorageClassUpdateTimeDateThe date and time when the terminal storage class was last updated for the bucket.
GCP.Storage.Buckets.labelsUnknownThe user-provided bucket labels, as key-value pairs.
GCP.Storage.Buckets.retentionPolicy.retentionPeriodStringThe minimum age in seconds that objects must reach before they can be deleted or replaced.
GCP.Storage.Buckets.retentionPolicy.effectiveTimeDateThe date and time from which the retention policy was effective.
GCP.Storage.Buckets.retentionPolicy.isLockedBooleanWhether the retention policy is locked.
GCP.Storage.Buckets.objectRetention.modeStringThe bucket's object retention mode. When enabled, retention configurations can be set on objects.
GCP.Storage.Buckets.billing.requesterPaysBooleanWhether Requester Pays is enabled for the bucket.
GCP.Storage.Buckets.softDeletePolicy.retentionDurationSecondsStringThe period in seconds during which a soft-deleted object is retained and cannot be permanently deleted.
GCP.Storage.Buckets.softDeletePolicy.effectiveTimeDateThe date and time when the soft delete policy becomes effective.
GCP.Storage.Buckets.customPlacementConfig.dataLocationsUnknownThe list of individual regions that comprise a configurable dual-region bucket.
GCP.Storage.Buckets.ipFilter.modeStringThe state of the IP filter configuration (Enabled or Disabled).

gcp-storage-bucket-object-upload#


Uploads a War Room file (by entry ID) to a GCS bucket as an object. Required permission: storage.objects.create.

Base Command#

gcp-storage-bucket-object-upload

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket to upload the object to.Required
object_nameThe name to give the uploaded object in the bucket.Required
entry_idThe War Room entry ID of the file to upload.Required
object_aclThe predefined ACL to apply to the uploaded object. Cannot be used when Uniform Bucket-Level Access is enabled on the bucket. Possible values are: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.nameStringThe name of the bucket containing the uploaded object.
GCP.Storage.Buckets.Objects.kindStringThe kind of item this is. For objects, this is always storage#object.
GCP.Storage.Buckets.Objects.idStringThe ID of the uploaded object, including the bucket name, object name, and generation number.
GCP.Storage.Buckets.Objects.selfLinkStringThe link to the uploaded object.
GCP.Storage.Buckets.Objects.mediaLinkStringThe media download link for the uploaded object.
GCP.Storage.Buckets.Objects.nameStringThe name of the uploaded object.
GCP.Storage.Buckets.Objects.bucketStringThe name of the bucket containing the object.
GCP.Storage.Buckets.Objects.generationStringThe content generation of the uploaded object. Used for object versioning.
GCP.Storage.Buckets.Objects.metagenerationStringThe version of the metadata for the object at this generation.
GCP.Storage.Buckets.Objects.contentTypeStringThe content type of the uploaded object.
GCP.Storage.Buckets.Objects.storageClassStringThe storage class of the uploaded object.
GCP.Storage.Buckets.Objects.sizeStringThe content length of the uploaded object in bytes.
GCP.Storage.Buckets.Objects.md5HashStringThe MD5 hash of the uploaded object.
GCP.Storage.Buckets.Objects.crc32cStringThe CRC32c checksum of the uploaded object.
GCP.Storage.Buckets.Objects.etagStringThe HTTP 1.1 Entity tag for the uploaded object.
GCP.Storage.Buckets.Objects.timeCreatedDateThe creation time of the uploaded object in RFC 3339 format.
GCP.Storage.Buckets.Objects.updatedDateThe modification time of the uploaded object metadata in RFC 3339 format.
GCP.Storage.Buckets.Objects.timeStorageClassUpdatedDateThe date and time when the object's storage class was last changed, in RFC 3339 format.
GCP.Storage.Buckets.Objects.contentEncodingStringThe content encoding of the uploaded object.
GCP.Storage.Buckets.Objects.contentDispositionStringThe content disposition of the uploaded object.
GCP.Storage.Buckets.Objects.contentLanguageStringThe content language of the uploaded object.
GCP.Storage.Buckets.Objects.cacheControlStringThe cache control directive for the uploaded object.
GCP.Storage.Buckets.Objects.metadataUnknownThe user-provided metadata, in key/value pairs.
GCP.Storage.Buckets.Objects.aclUnknownThe access control list for the uploaded object.
GCP.Storage.Buckets.Objects.ownerObjectThe owner of the object, including the owner entity and entity ID.
GCP.Storage.Buckets.Objects.componentCountNumberThe number of component objects that make up a composite object.
GCP.Storage.Buckets.Objects.customTimeDateThe user-specified timestamp for the uploaded object, in RFC 3339 format.
GCP.Storage.Buckets.Objects.eventBasedHoldBooleanWhether an event-based hold is active on the uploaded object.
GCP.Storage.Buckets.Objects.temporaryHoldBooleanWhether a temporary hold is active on the uploaded object.
GCP.Storage.Buckets.Objects.retentionExpirationTimeDateThe earliest date and time when the object can be deleted based on the bucket's retention policy, in RFC 3339 format.
GCP.Storage.Buckets.Objects.kmsKeyNameStringThe Cloud KMS key used to encrypt the uploaded object, if any.
GCP.Storage.Buckets.Objects.customerEncryptionObjectThe customer-supplied encryption key information, including the algorithm and the SHA256 hash of the key.

gcp-storage-bucket-object-download#


Downloads an object from a GCS bucket and returns it as a War Room file. Required permission: storage.objects.get.

Base Command#

gcp-storage-bucket-object-download

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket containing the object.Required
object_nameThe name of the object to download.Required
saved_file_nameThe name to give the downloaded file in the War Room. Defaults to the last path segment of the object name.Optional

Context Output#

PathTypeDescription
File.NameStringThe name of the downloaded file.
File.EntryIDStringThe War Room entry ID of the downloaded file.
File.SizeNumberThe size of the downloaded file in bytes.
File.MD5StringThe MD5 hash of the downloaded file.
File.SHA1StringThe SHA1 hash of the downloaded file.
File.SHA256StringThe SHA256 hash of the downloaded file.

gcp-storage-bucket-object-copy#


Copies an object from a source bucket to a destination bucket. Required permissions: storage.objects.get, storage.objects.create.

Base Command#

gcp-storage-bucket-object-copy

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
source_bucket_nameThe name of the source bucket containing the object to copy.Required
source_object_nameThe name of the object to copy.Required
destination_bucket_nameThe name of the destination bucket to copy the object to.Required
destination_object_nameThe name to give the copied object in the destination bucket. Defaults to the source object name.Optional

Context Output#

PathTypeDescription
GCP.Storage.Buckets.nameStringThe name of the destination bucket containing the copied object.
GCP.Storage.Buckets.Objects.kindStringThe kind of item this is. For objects, this is always storage#object.
GCP.Storage.Buckets.Objects.idStringThe ID of the copied object, including the bucket name, object name, and generation number.
GCP.Storage.Buckets.Objects.selfLinkStringThe link to the copied object.
GCP.Storage.Buckets.Objects.mediaLinkStringThe media download link for the copied object.
GCP.Storage.Buckets.Objects.nameStringThe name of the copied object.
GCP.Storage.Buckets.Objects.bucketStringThe name of the bucket containing the object.
GCP.Storage.Buckets.Objects.generationStringThe content generation of the copied object. Used for object versioning.
GCP.Storage.Buckets.Objects.metagenerationStringThe version of the metadata for the object at this generation.
GCP.Storage.Buckets.Objects.contentTypeStringThe content type of the copied object.
GCP.Storage.Buckets.Objects.storageClassStringThe storage class of the copied object.
GCP.Storage.Buckets.Objects.sizeStringThe content length of the copied object in bytes.
GCP.Storage.Buckets.Objects.md5HashStringThe MD5 hash of the copied object.
GCP.Storage.Buckets.Objects.crc32cStringThe CRC32c checksum of the copied object.
GCP.Storage.Buckets.Objects.etagStringThe HTTP 1.1 Entity tag for the copied object.
GCP.Storage.Buckets.Objects.timeCreatedDateThe creation date and time of the copied object, in RFC 3339 format.
GCP.Storage.Buckets.Objects.updatedDateThe modification time of the copied object metadata, in RFC 3339 format.
GCP.Storage.Buckets.Objects.timeStorageClassUpdatedDateThe date and time when the object's storage class was last changed, in RFC 3339 format.
GCP.Storage.Buckets.Objects.contentEncodingStringThe content encoding of the copied object.
GCP.Storage.Buckets.Objects.contentDispositionStringThe content disposition of the copied object.
GCP.Storage.Buckets.Objects.contentLanguageStringThe content language of the copied object.
GCP.Storage.Buckets.Objects.cacheControlStringThe cache control directive for the copied object.
GCP.Storage.Buckets.Objects.metadataUnknownThe user-provided metadata, in key/value pairs.
GCP.Storage.Buckets.Objects.aclUnknownThe access control list for the copied object.
GCP.Storage.Buckets.Objects.ownerObjectThe owner of the object, including the owner entity and entity ID.
GCP.Storage.Buckets.Objects.componentCountNumberThe number of component objects that make up a composite object.
GCP.Storage.Buckets.Objects.customTimeDateThe user-specified timestamp for the copied object, in RFC 3339 format.
GCP.Storage.Buckets.Objects.eventBasedHoldBooleanWhether an event-based hold is active on the copied object.
GCP.Storage.Buckets.Objects.temporaryHoldBooleanWhether a temporary hold is active on the copied object.
GCP.Storage.Buckets.Objects.retentionExpirationTimeDateThe earliest date and time when the object can be deleted based on the bucket's retention policy, in RFC 3339 format.
GCP.Storage.Buckets.Objects.kmsKeyNameStringThe Cloud KMS key used to encrypt the copied object, if any.
GCP.Storage.Buckets.Objects.customerEncryptionObjectThe customer-supplied encryption key information, including the algorithm and the SHA256 hash of the key.

gcp-storage-bucket-object-delete#


Deletes an object from a GCS bucket. Required permission: storage.objects.delete.

Base Command#

gcp-storage-bucket-object-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket containing the object.Required
object_nameThe name of the object to delete.Required
generationThe specific revision of the object to permanently delete instead of the latest version.Optional

Context Output#

There is no context output for this command.

gcp-storage-bucket-object-policy-delete#


Removes an ACL entry (entity) from a GCS object's access control list. If Uniform Bucket-Level Access is enabled on the bucket, use gcp-storage-bucket-policy-delete instead. Required permissions: storage.objects.get, storage.objects.update.

Base Command#

gcp-storage-bucket-object-policy-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
bucket_nameThe name of the bucket containing the object.Required
object_nameThe name of the object to remove the ACL entry from.Required
entityThe entity to remove from the object's ACL (for example, allUsers, allAuthenticatedUsers, user-test@example.com).Required
generationThe specific revision of the object to target.Optional

Context Output#

There is no context output for this command.

gcp-kms-key-rings-list#


Lists the Cloud KMS key rings in a given location, or across all locations. Required Permissions: cloudkms.keyRings.list.

Base Command#

gcp-kms-key-rings-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
all_locationsWhether to return the key rings from all supported locations. When set to true, the location argument is ignored. Possible values are: true, false. Default is false.Optional
limitThe maximum number of key rings to return per location. Valid range 1-500. Default is 50.Optional
page_tokenThe token for the next page of results, used for pagination. Ignored when all_locations is set to true, because a page token is bound to a single location.Optional

Context Output#

PathTypeDescription
GCP.KMS.KeyRings.NameStringThe ID of the key ring.
GCP.KMS.KeyRings.ResourceNameStringThe full resource name of the key ring.
GCP.KMS.KeyRings.ProjectStringThe project that holds the key ring.
GCP.KMS.KeyRings.LocationStringThe location of the key ring.
GCP.KMS.KeyRings.createTimeDateThe time at which the key ring was created.
GCP.KMS.KeyRingsNextTokenStringThe token to pass as the page_token argument to retrieve the next page of key rings.

gcp-kms-keys-list#


Lists the crypto keys of a given Cloud KMS key ring. Required Permissions: cloudkms.cryptoKeys.list.

Base Command#

gcp-kms-keys-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto keys.Required
key_stateReturns only keys whose primary crypto key version is in this state. Leave empty to return all keys. Possible values are: ENABLED, DISABLED, DESTROYED, DESTROY_SCHEDULED, PENDING_GENERATION, PENDING_IMPORT, IMPORT_FAILED.Optional
limitThe maximum number of crypto keys to return. Valid range 1-500. Default is 50.Optional
page_tokenThe token for the next page of results, used for pagination.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeys.NameStringThe ID of the crypto key.
GCP.KMS.CryptoKeys.ResourceNameStringThe full resource name of the crypto key.
GCP.KMS.CryptoKeys.ProjectStringThe project that holds the crypto key.
GCP.KMS.CryptoKeys.LocationStringThe location of the crypto key.
GCP.KMS.CryptoKeys.KeyRingStringThe key ring that holds the crypto key.
GCP.KMS.CryptoKeys.purposeStringThe immutable purpose of the crypto key.
GCP.KMS.CryptoKeys.createTimeDateThe time at which the crypto key was created.
GCP.KMS.CryptoKeys.nextRotationTimeDateThe time at which the next scheduled rotation is due to run.
GCP.KMS.CryptoKeys.rotationPeriodStringThe period between automatic key rotations.
GCP.KMS.CryptoKeys.labelsUnknownThe labels with user-defined metadata.
GCP.KMS.CryptoKeys.versionTemplateUnknownThe version template of the crypto key, containing the protectionLevel and algorithm fields.
GCP.KMS.CryptoKeys.primaryUnknownThe primary crypto key version, containing the name, state, createTime, protectionLevel, algorithm, and generateTime fields.
GCP.KMS.CryptoKeysNextTokenStringThe token to use when requesting the next set of crypto keys.

gcp-kms-keys-list-all#


Lists every crypto key across all key rings in a location, or across all locations. Required Permissions: cloudkms.keyRings.list, cloudkms.cryptoKeys.list.

Base Command#

gcp-kms-keys-list-all

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
all_locationsWhether to return the crypto keys from all supported locations. When set to true, the location argument is ignored. Possible values are: true, false. Default is false.Optional
key_stateReturns only keys whose primary crypto key version is in this state. Leave empty to return all keys. Possible values are: ENABLED, DISABLED, DESTROYED, DESTROY_SCHEDULED, PENDING_GENERATION, PENDING_IMPORT, IMPORT_FAILED.Optional
limitThe maximum number of crypto keys to return per key ring. Valid range 1-500. This command aggregates results across key rings and cannot be paged. If any key ring holds more keys than this limit, a truncation notice is returned. Use gcp-kms-keys-list to page through a single key ring. Default is 50.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeys.NameStringThe ID of the crypto key.
GCP.KMS.CryptoKeys.ResourceNameStringThe full resource name of the crypto key.
GCP.KMS.CryptoKeys.ProjectStringThe project that holds the crypto key.
GCP.KMS.CryptoKeys.LocationStringThe location of the crypto key.
GCP.KMS.CryptoKeys.KeyRingStringThe key ring that holds the crypto key.
GCP.KMS.CryptoKeys.purposeStringThe immutable purpose of the crypto key.
GCP.KMS.CryptoKeys.createTimeDateThe time at which the crypto key was created.
GCP.KMS.CryptoKeys.nextRotationTimeDateThe time at which the next scheduled rotation is due to run.
GCP.KMS.CryptoKeys.rotationPeriodStringThe period between automatic key rotations.
GCP.KMS.CryptoKeys.labelsUnknownThe labels with user-defined metadata.
GCP.KMS.CryptoKeys.versionTemplateUnknownThe version template of the crypto key, containing the protectionLevel and algorithm fields.
GCP.KMS.CryptoKeys.primaryUnknownThe primary crypto key version, containing the name, state, createTime, protectionLevel, algorithm, and generateTime fields.

gcp-kms-key-get#


Returns the metadata of a given crypto key and its primary crypto key version. Required Permissions: cloudkms.cryptoKeys.get.

Base Command#

gcp-kms-key-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to fetch.Required

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeys.NameStringThe ID of the crypto key.
GCP.KMS.CryptoKeys.ResourceNameStringThe full resource name of the crypto key.
GCP.KMS.CryptoKeys.ProjectStringThe project that holds the crypto key.
GCP.KMS.CryptoKeys.LocationStringThe location of the crypto key.
GCP.KMS.CryptoKeys.KeyRingStringThe key ring that holds the crypto key.
GCP.KMS.CryptoKeys.purposeStringThe immutable purpose of the crypto key.
GCP.KMS.CryptoKeys.createTimeDateThe time at which the crypto key was created.
GCP.KMS.CryptoKeys.nextRotationTimeDateThe time at which the next scheduled rotation is due to run.
GCP.KMS.CryptoKeys.rotationPeriodStringThe period between automatic key rotations.
GCP.KMS.CryptoKeys.labelsUnknownThe labels with user-defined metadata.
GCP.KMS.CryptoKeys.versionTemplateUnknownThe version template of the crypto key, containing the protectionLevel and algorithm fields.
GCP.KMS.CryptoKeys.primaryUnknownThe primary crypto key version, containing the name, state, createTime, protectionLevel, algorithm, and generateTime fields.

gcp-kms-key-create#


Creates a new crypto key within a given key ring. Required Permissions: cloudkms.cryptoKeys.create.

Base Command#

gcp-kms-key-create

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring in which to create the crypto key.Required
crypto_keyThe ID of the crypto key to create. Must be unique within the key ring and match the regular expression [a-zA-Z0-9_-]{1,63}.Required
purposeThe immutable cryptographic capability of the crypto key. Possible values are: ENCRYPT_DECRYPT, ASYMMETRIC_SIGN, ASYMMETRIC_DECRYPT. Default is ENCRYPT_DECRYPT.Optional
algorithmThe algorithm to use when creating a crypto key version based on this template. Possible values are: GOOGLE_SYMMETRIC_ENCRYPTION, RSA_SIGN_PSS_2048_SHA256, RSA_SIGN_PSS_3072_SHA256, RSA_SIGN_PSS_4096_SHA256, RSA_SIGN_PSS_4096_SHA512, RSA_SIGN_PKCS1_2048_SHA256, RSA_SIGN_PKCS1_3072_SHA256, RSA_SIGN_PKCS1_4096_SHA256, RSA_SIGN_PKCS1_4096_SHA512, RSA_DECRYPT_OAEP_2048_SHA256, RSA_DECRYPT_OAEP_3072_SHA256, RSA_DECRYPT_OAEP_4096_SHA256, RSA_DECRYPT_OAEP_4096_SHA512, EC_SIGN_P256_SHA256, EC_SIGN_P384_SHA384. Default is GOOGLE_SYMMETRIC_ENCRYPTION.Optional
protection_levelThe protection level to use when creating a crypto key version based on this template. Possible values are: SOFTWARE, HSM. Default is SOFTWARE.Optional
rotation_periodThe period between automatic key rotations, as a duration in seconds (for example, 7776000s). Must be between 24 hours and 876,000 hours. Supported only for keys whose purpose is ENCRYPT_DECRYPT.Optional
next_rotation_timeThe time of the next scheduled rotation. Accepts an absolute timestamp in RFC3339 UTC "Zulu" format (for example, 2024-10-02T15:01:23Z) or a relative expression (for example, "in 30 days"). Supported only for keys whose purpose is ENCRYPT_DECRYPT.Optional
labelsThe labels with user-defined metadata, in the format key=abc,value=123;key=def,value=456.Optional
skip_initial_version_creationWhether to create the crypto key without an initial crypto key version. When set to true, a crypto key version must be created before the key can be used. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeys.NameStringThe ID of the crypto key.
GCP.KMS.CryptoKeys.ResourceNameStringThe full resource name of the crypto key.
GCP.KMS.CryptoKeys.ProjectStringThe project that holds the crypto key.
GCP.KMS.CryptoKeys.LocationStringThe location of the crypto key.
GCP.KMS.CryptoKeys.KeyRingStringThe key ring that holds the crypto key.
GCP.KMS.CryptoKeys.purposeStringThe immutable purpose of the crypto key.
GCP.KMS.CryptoKeys.createTimeDateThe time at which the crypto key was created.
GCP.KMS.CryptoKeys.nextRotationTimeDateThe time at which the next scheduled rotation is due to run.
GCP.KMS.CryptoKeys.rotationPeriodStringThe period between automatic key rotations.
GCP.KMS.CryptoKeys.labelsUnknownThe labels with user-defined metadata.
GCP.KMS.CryptoKeys.versionTemplateUnknownThe version template of the crypto key, containing the protectionLevel and algorithm fields.
GCP.KMS.CryptoKeys.primaryUnknownThe primary crypto key version, containing the name, state, createTime, protectionLevel, algorithm, and generateTime fields.

gcp-kms-key-update#


Updates the mutable fields of a given crypto key. Only the supplied fields are updated. Required Permissions: cloudkms.cryptoKeys.update.

Base Command#

gcp-kms-key-update

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to update.Required
labelsThe labels with user-defined metadata, in the format key=abc,value=123;key=def,value=456.Optional
next_rotation_timeThe time of the next scheduled rotation. Accepts an absolute timestamp in RFC3339 UTC "Zulu" format (for example, 2024-10-02T15:01:23Z) or a relative expression (for example, "in 30 days").Optional
rotation_periodThe period between automatic key rotations, as a duration in seconds (for example, 7776000s). Must be between 24 hours and 876,000 hours.Optional
algorithmThe algorithm to use when creating a crypto key version based on this template. Possible values are: GOOGLE_SYMMETRIC_ENCRYPTION, RSA_SIGN_PSS_2048_SHA256, RSA_SIGN_PSS_3072_SHA256, RSA_SIGN_PSS_4096_SHA256, RSA_SIGN_PSS_4096_SHA512, RSA_SIGN_PKCS1_2048_SHA256, RSA_SIGN_PKCS1_3072_SHA256, RSA_SIGN_PKCS1_4096_SHA256, RSA_SIGN_PKCS1_4096_SHA512, RSA_DECRYPT_OAEP_2048_SHA256, RSA_DECRYPT_OAEP_3072_SHA256, RSA_DECRYPT_OAEP_4096_SHA256, RSA_DECRYPT_OAEP_4096_SHA512, EC_SIGN_P256_SHA256, EC_SIGN_P384_SHA384.Optional
protection_levelThe protection level to use when creating a crypto key version based on this template. Possible values are: SOFTWARE, HSM.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeys.NameStringThe ID of the crypto key.
GCP.KMS.CryptoKeys.ResourceNameStringThe full resource name of the crypto key.
GCP.KMS.CryptoKeys.ProjectStringThe project that holds the crypto key.
GCP.KMS.CryptoKeys.LocationStringThe location of the crypto key.
GCP.KMS.CryptoKeys.KeyRingStringThe key ring that holds the crypto key.
GCP.KMS.CryptoKeys.purposeStringThe immutable purpose of the crypto key.
GCP.KMS.CryptoKeys.createTimeDateThe time at which the crypto key was created.
GCP.KMS.CryptoKeys.nextRotationTimeDateThe time at which the next scheduled rotation is due to run.
GCP.KMS.CryptoKeys.rotationPeriodStringThe period between automatic key rotations.
GCP.KMS.CryptoKeys.labelsUnknownThe labels with user-defined metadata.
GCP.KMS.CryptoKeys.versionTemplateUnknownThe version template of the crypto key, containing the protectionLevel and algorithm fields.
GCP.KMS.CryptoKeys.primaryUnknownThe primary crypto key version, containing the name, state, createTime, protectionLevel, algorithm, and generateTime fields.

gcp-kms-key-version-enable#


Enables a crypto key version of a given crypto key. Required Permissions: cloudkms.cryptoKeyVersions.update, cloudkms.cryptoKeys.get.

Base Command#

gcp-kms-key-version-enable

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to enable.Required
crypto_key_versionThe ID of the crypto key version to enable. Use the keyword default to target the primary crypto key version of the given crypto key. Default is default.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeyVersions.nameStringThe resource name of the crypto key version.
GCP.KMS.CryptoKeyVersions.stateStringThe current state of the crypto key version.
GCP.KMS.CryptoKeyVersions.protectionLevelStringThe protection level describing how cryptographic operations are performed.
GCP.KMS.CryptoKeyVersions.algorithmStringThe algorithm that the crypto key version supports.
GCP.KMS.CryptoKeyVersions.createTimeDateThe time at which the crypto key version was created. The value is an RFC 3339 UTC timestamp (for example, 2024-01-15T12:34:56.789012Z).

gcp-kms-key-version-disable#


Disables a crypto key version of a given crypto key. Required Permissions: cloudkms.cryptoKeyVersions.update, cloudkms.cryptoKeys.get.

Base Command#

gcp-kms-key-version-disable

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to disable.Required
crypto_key_versionThe ID of the crypto key version to disable. Use the keyword default to target the primary crypto key version of the given crypto key. Default is default.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeyVersions.nameStringThe resource name of the crypto key version.
GCP.KMS.CryptoKeyVersions.stateStringThe current state of the crypto key version.
GCP.KMS.CryptoKeyVersions.protectionLevelStringThe protection level describing how cryptographic operations are performed.
GCP.KMS.CryptoKeyVersions.algorithmStringThe algorithm that the crypto key version supports.
GCP.KMS.CryptoKeyVersions.createTimeDateThe time at which the crypto key version was created. The value is an RFC 3339 UTC timestamp (for example, 2024-01-15T12:34:56.789012Z).

gcp-kms-key-version-destroy#


Schedules a crypto key version for destruction. The key material is destroyed 24 hours later. Required Permissions: cloudkms.cryptoKeyVersions.destroy, cloudkms.cryptoKeys.get.

Base Command#

gcp-kms-key-version-destroy

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to destroy.Required
crypto_key_versionThe ID of the crypto key version to destroy. Use the keyword default to target the primary crypto key version of the given crypto key. Default is default.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeyVersions.nameStringThe resource name of the crypto key version.
GCP.KMS.CryptoKeyVersions.stateStringThe current state of the crypto key version.
GCP.KMS.CryptoKeyVersions.destroyTimeDateThe time at which the crypto key version material is scheduled to be destroyed. The value is an RFC 3339 UTC timestamp (for example, 2024-01-15T12:34:56.789012Z).

gcp-kms-key-version-restore#


Restores a crypto key version that is scheduled for destruction. Required Permissions: cloudkms.cryptoKeyVersions.restore, cloudkms.cryptoKeys.get.

Base Command#

gcp-kms-key-version-restore

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to restore.Required
crypto_key_versionThe ID of the crypto key version to restore. Use the keyword default to target the primary crypto key version of the given crypto key. Default is default.Optional

Context Output#

PathTypeDescription
GCP.KMS.CryptoKeyVersions.nameStringThe resource name of the crypto key version.
GCP.KMS.CryptoKeyVersions.stateStringThe current state of the crypto key version.
GCP.KMS.CryptoKeyVersions.protectionLevelStringThe protection level describing how cryptographic operations are performed.
GCP.KMS.CryptoKeyVersions.algorithmStringThe algorithm that the crypto key version supports.

gcp-kms-public-key-get#


Returns the public key of a given asymmetric crypto key version. Required Permissions: cloudkms.cryptoKeyVersions.viewPublicKey.

Base Command#

gcp-kms-public-key-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the asymmetric crypto key.Required
crypto_key_versionThe ID of the crypto key version whose public key is returned. Default is 1.Optional

Context Output#

PathTypeDescription
GCP.KMS.PublicKey.CryptoKeyStringThe crypto key to which the public key belongs.
GCP.KMS.PublicKey.CryptoKeyVersionStringThe resource name of the crypto key version.
GCP.KMS.PublicKey.pemStringThe public key in PEM format.
GCP.KMS.PublicKey.pemCrc32cStringThe CRC32C checksum of the returned PEM public key.
GCP.KMS.PublicKey.algorithmStringThe algorithm of the public key.
GCP.KMS.PublicKey.nameStringThe resource name of the crypto key version returned by the API.
GCP.KMS.PublicKey.protectionLevelStringThe protection level of the crypto key version.

gcp-kms-symmetric-encrypt#


Encrypts data using a symmetric crypto key. Required Permissions: cloudkms.cryptoKeyVersions.useToEncrypt.

Base Command#

gcp-kms-symmetric-encrypt

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to encrypt with.Required
plaintextThe plaintext to encrypt. Must be no larger than 64KiB. Mutually exclusive with base64_plaintext and entry_id.Optional
base64_plaintextThe Base64-encoded plaintext to encrypt. Mutually exclusive with plaintext and entry_id.Optional
entry_idThe War Room entry ID of the file to encrypt. Mutually exclusive with plaintext and base64_plaintext.Optional
additional_authenticated_dataThe Base64-encoded additional authenticated data (AAD). The same value must be supplied when decrypting.Optional

Context Output#

PathTypeDescription
GCP.KMS.SymmetricEncrypt.CryptoKeyStringThe crypto key used for the encryption.
GCP.KMS.SymmetricEncrypt.ResourceNameStringThe full resource name of the crypto key used for the encryption.
GCP.KMS.SymmetricEncrypt.ciphertextStringThe Base64-encoded encrypted ciphertext.
GCP.KMS.SymmetricEncrypt.ciphertextCrc32cStringThe CRC32C checksum of the returned ciphertext.
GCP.KMS.SymmetricEncrypt.verifiedPlaintextCrc32cBooleanWhether the API verified the CRC32C checksum of the supplied plaintext.
GCP.KMS.SymmetricEncrypt.nameStringThe resource name of the crypto key version used for the encryption.
GCP.KMS.SymmetricEncrypt.protectionLevelStringThe protection level of the crypto key version used for the encryption.

gcp-kms-symmetric-decrypt#


Decrypts data that was encrypted with a symmetric crypto key. Required Permissions: cloudkms.cryptoKeyVersions.useToDecrypt.

Base Command#

gcp-kms-symmetric-decrypt

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the crypto key to decrypt with.Required
ciphertextThe Base64-encoded ciphertext to decrypt. Mutually exclusive with entry_id.Optional
entry_idThe War Room entry ID of the file holding the raw ciphertext bytes to decrypt. Mutually exclusive with ciphertext.Optional
additional_authenticated_dataThe Base64-encoded additional authenticated data (AAD) that was supplied during encryption.Optional

Context Output#

PathTypeDescription
GCP.KMS.SymmetricDecrypt.CryptoKeyStringThe crypto key used for the decryption.
GCP.KMS.SymmetricDecrypt.ResourceNameStringThe full resource name of the crypto key used for the decryption.
GCP.KMS.SymmetricDecrypt.PlaintextStringThe decrypted plaintext. Omitted when the decrypted data is binary, in which case it is returned as a file instead.
GCP.KMS.SymmetricDecrypt.FullResponseUnknownThe full API response returned by the decrypt operation.

gcp-kms-asymmetric-encrypt#


Encrypts data with the public key of an asymmetric crypto key version. The encryption is performed locally using the retrieved public key. Required Permissions: cloudkms.cryptoKeyVersions.viewPublicKey.

Base Command#

gcp-kms-asymmetric-encrypt

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the asymmetric crypto key to encrypt with.Required
crypto_key_versionThe ID of the crypto key version to encrypt with. Default is 1.Optional
plaintextThe plaintext to encrypt. Mutually exclusive with base64_plaintext and entry_id.Optional
base64_plaintextThe Base64-encoded plaintext to encrypt. Mutually exclusive with plaintext and entry_id.Optional
entry_idThe War Room entry ID of the file to encrypt. Mutually exclusive with plaintext and base64_plaintext.Optional

Context Output#

PathTypeDescription
GCP.KMS.AsymmetricEncrypt.CryptoKeyStringThe crypto key used for the encryption.
GCP.KMS.AsymmetricEncrypt.CryptoKeyVersionStringThe resource name of the crypto key version used for the encryption.
GCP.KMS.AsymmetricEncrypt.CiphertextStringThe Base64-encoded encrypted ciphertext.
GCP.KMS.AsymmetricEncrypt.pemStringThe public key, in PEM format, that was used for the encryption.
GCP.KMS.AsymmetricEncrypt.algorithmStringThe algorithm of the public key that was used for the encryption.
GCP.KMS.AsymmetricEncrypt.nameStringThe resource name of the crypto key version returned by the API.
GCP.KMS.AsymmetricEncrypt.protectionLevelStringThe protection level of the crypto key version used for the encryption.

gcp-kms-asymmetric-decrypt#


Decrypts data using an asymmetric crypto key version. Required Permissions: cloudkms.cryptoKeyVersions.useToDecrypt.

Base Command#

gcp-kms-asymmetric-decrypt

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
locationThe geographical region where the Cloud KMS resources are handled. For more information, see https://cloud.google.com/kms/docs/locations. Default is global.Optional
key_ringThe ID of the key ring that holds the crypto key.Required
crypto_keyThe ID of the asymmetric crypto key to decrypt with.Required
crypto_key_versionThe ID of the crypto key version to decrypt with. Default is 1.Optional
ciphertextThe Base64-encoded ciphertext to decrypt. Mutually exclusive with entry_id.Optional
entry_idThe War Room entry ID of the file holding the raw ciphertext bytes to decrypt. Mutually exclusive with ciphertext.Optional

Context Output#

PathTypeDescription
GCP.KMS.AsymmetricDecrypt.CryptoKeyStringThe crypto key used for the decryption.
GCP.KMS.AsymmetricDecrypt.CryptoKeyVersionStringThe resource name of the crypto key version used for the decryption.
GCP.KMS.AsymmetricDecrypt.PlaintextStringThe decrypted plaintext. Omitted when the decrypted data is binary, in which case it is returned as a file instead.
GCP.KMS.AsymmetricDecrypt.plaintextCrc32cStringThe CRC32C checksum of the returned plaintext.
GCP.KMS.AsymmetricDecrypt.verifiedCiphertextCrc32cBooleanWhether the API verified the CRC32C checksum of the supplied ciphertext.
GCP.KMS.AsymmetricDecrypt.protectionLevelStringThe protection level of the crypto key version used for the decryption.

gcp-compute-instance-insert#


Creates a Compute Engine VM instance in the specified project and zone. Returns a zone Operation resource describing the asynchronous creation. Required permission: compute.instances.create.

Base Command#

gcp-compute-instance-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
nameThe name of the instance to create.Required
machine_typeThe machine type. Can be a bare name (for example, n1-standard-1), in which case the zone-qualified URL is built automatically, or a full/partial URL (for example, zones/zone/machineTypes/n1-standard-1).Required
descriptionThe optional description for the instance.Optional
tagsThe comma-separated list of network tags to apply to the instance.Optional
tags_fingerprintThe fingerprint hash of the tags contents, used for optimistic locking.Optional
can_ip_forwardWhether the instance is allowed to send and receive packets with non-matching destination or source IPs. Possible values are: true, false.Optional
networkThe URL of the network resource for this instance.Optional
subnetworkThe URL of the subnetwork resource for this instance.Optional
network_ipThe IPv4 internal IP address to assign to the instance.Optional
external_internet_accessWhether to grant the instance external internet access by adding a ONE_TO_ONE_NAT access config. Possible values are: true, false.Optional
external_nat_ipThe static external IP address to assign to the instance. Requires the external_internet_access argument.Optional
disk_sourceThe URL of an existing persistent disk to attach to the instance.Optional
disk_device_nameThe unique device name for the attached disk, reflected in the /dev/disk/by-id/google-* tree.Optional
disk_bootWhether this is a boot disk. Only one boot disk can be attached to an instance. Possible values are: true, false.Optional
disk_auto_deleteWhether the disk is deleted automatically when the instance is deleted. Possible values are: true, false.Optional
source_imageThe source image URL from which to create the boot disk. For example, projects/debian-cloud/global/images/family/debian-11.Optional
disk_size_gbThe size of the boot disk to create, in GB.Optional
disk_typeThe disk type URL for the created boot disk, for example zones/zone/diskTypes/pd-standard.Optional
metadata_itemsThe metadata key/value pairs to assign to the instance, in the format: key=abc,value=123;key=fed,value=456.Optional
service_account_emailThe email address of the service account to associate with the instance. Must be provided together with the service_account_scopes argument.Optional
service_account_scopesA comma-separated list of OAuth2 scopes for the service account. Must be provided together with service_account_email.Optional
labelsThe labels to apply to the instance, in the format: key=abc,value=123;key=fed,value=456.Optional
deletion_protectionWhether the instance should be protected against deletion. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe server-defined unique identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides, available only for per-zone operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId if provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation. For example: insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation. Can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100. The number monotonically increases as the operation progresses, but is not linear, does not support specific granularity, and should not be used to estimate completion time.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorstringThe errors generated during the operation.
GCP.Compute.Operations.warningsstringThe warning messages generated during the operation.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails (for example, 404 if the resource is not found).
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails (for example, NOT FOUND).
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides, available only for regional operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-delete#


Deletes the specified Compute Engine VM instance. Returns a zone Operation resource describing the asynchronous deletion. Required permission: compute.instances.delete.

Base Command#

gcp-compute-instance-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the instance resource to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe server-defined unique identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides, available only for per-zone operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId, if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource modified by the operation. For snapshot creation operations, this points to the source persistent disk.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100. The number monotonically increases as the operation progresses, but is not linear, does not guarantee specific operation granularity, and should not be used to estimate completion time.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorstringThe errors generated during the operation.
GCP.Compute.Operations.warningsstringThe warning messages generated during the operation.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails (for example, 404 if the resource is not found).
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails (for example, NOT FOUND).
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides, available only for regional operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-reset#


Performs a hard reset on the specified Compute Engine VM instance. Returns a zone Operation resource describing the asynchronous reset. Required permission: compute.instances.reset.

Base Command#

gcp-compute-instance-reset

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the instance resource to reset.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe server-defined unique identifier for the resource.
GCP.Compute.Operations.namestringThe resource name.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides, available only for per-zone operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId, if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource modified by the operation. For snapshot creation operations, this points to the source persistent disk.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100. The number monotonically increases as the operation progresses, but is not linear, does not support specific granularity, and should not be used to estimate completion time.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorstringThe errors generated during the operation.
GCP.Compute.Operations.warningsstringThe warning messages generated during the operation.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails (for example, 404 if the resource is not found).
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails (for example, NOT FOUND).
GCP.Compute.Operations.selfLinkstringThe server-defined resource URL.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides, available only for regional operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-metadata-set#


Sets metadata for the specified Compute Engine VM instance. Returns a zone Operation resource describing the asynchronous update. Required permission: compute.instances.setMetadata.

Base Command#

gcp-compute-instance-metadata-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the instance resource for which to set metadata.Required
metadata_fingerprintA fingerprint hash of the metadata's contents, used for optimistic locking. If not provided, the current fingerprint is fetched automatically from the instance (requires the compute.instances.get permission).Optional
metadata_itemsThe metadata key/value pairs to set on the instance, in the format: key=abc,value=123;key=fed,value=456. This replaces the instance metadata in full rather than merging, so any key that is not listed is removed, including keys such as ssh-keys and startup-script. Pass an empty value to clear all metadata.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe server-defined unique identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides, available only for per-zone operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId, if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource modified by the operation. For snapshot creation operations, this points to the source persistent disk.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringAn optional textual description of the current operation status.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100. The number monotonically increases as the operation progresses, but is not linear, does not support specific granularity, and should not be used to estimate completion time.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorstringThe errors generated during the operation.
GCP.Compute.Operations.warningsstringThe warning messages generated during the operation.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails (for example, 404 if the resource is not found).
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails (for example, NOT FOUND).
GCP.Compute.Operations.selfLinkstringServer-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides, available only for regional operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-instances-aggregated-list#


Retrieves an aggregated list of all Compute Engine VM instances across every zone in the project. Required permission: compute.instances.list.

Base Command#

gcp-compute-instances-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
filterThe filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a Compute Engine instance named example-instance, use name != example-instance.Optional
limitThe maximum number of results per page that should be returned. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
order_byThe sort order for list results, defaulting to alphanumerical order by resource name. To sort by creation timestamp in descending order, use order_by=creationTimestamp desc.Optional
next_tokenThe page token used to retrieve the next page of results. Set next_token to the AggregatedInstancesNextToken value returned from a previous request.Optional

Context Output#

PathTypeDescription
GCP.Compute.Instances.kindStringType of the resource. Always compute#instance for instances.
GCP.Compute.Instances.idStringThe unique identifier of the resource.
GCP.Compute.Instances.creationTimestampStringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Instances.nameStringThe name of the resource, provided by the client when the resource is first created.
GCP.Compute.Instances.descriptionStringThe optional description for this resource.
GCP.Compute.Instances.machineTypeStringThe full or partial URL of the machine type resource for this instance, in the format: zones/zone/machineTypes/machine-type.
GCP.Compute.Instances.statusStringThe status of the instance.
GCP.Compute.Instances.zoneStringThe URL of the zone where the instance resides.
GCP.Compute.Instances.tagsStringThe tags to apply to this instance.
GCP.Compute.Instances.statusMessageStringThe optional, human-readable explanation of the status.
GCP.Compute.Instances.canIpForwardStringAllows this instance to send and receive packets with non-matching destination or source IPs.
GCP.Compute.Instances.networkInterfacesObjectThe array of network configurations for the instance.
GCP.Compute.Instances.disksObjectThe array of disks associated with the instance.
GCP.Compute.Instances.metadataObjectThe metadata key/value pairs assigned to the instance.
GCP.Compute.Instances.serviceAccountsObjectThe list of service accounts, with their specified scopes, authorized for the instance.
GCP.Compute.Instances.selfLinkStringThe server-defined resource URL.
GCP.Compute.Instances.schedulingObjectSets the scheduling options for the instance.
GCP.Compute.Instances.cpuPlatformStringThe CPU platform used by the instance.
GCP.Compute.Instances.labelsStringThe labels to apply to the instance.
GCP.Compute.Instances.labelFingerprintStringThe fingerprint for this request, which is a hash of the label's contents and used for optimistic locking.
GCP.Compute.Instances.instanceEncryptionKeyObjectEncrypts suspended data for an instance with a customer-managed encryption key.
GCP.Compute.Instances.minCpuPlatformStringSpecifies a minimum CPU platform for the VM instance.
GCP.Compute.Instances.guestAcceleratorsObjectThe list of the type and count of accelerator cards attached to the instance.
GCP.Compute.Instances.startRestrictedBooleanWhether a VM has been restricted from starting because Compute Engine detected suspicious activity.
GCP.Compute.Instances.deletionProtectionBooleanWhether the resource should be protected against deletion.
GCP.Compute.Instances.resourcePoliciesStringThe resource policies applied to this instance.
GCP.Compute.Instances.sourceMachineImageStringThe source machine image.
GCP.Compute.Instances.reservationAffinityObjectThe reservations that the instance can consume.
GCP.Compute.Instances.hostnameStringThe hostname of the instance.
GCP.Compute.Instances.displayDeviceObjectThe display device configuration for the instance.
GCP.Compute.Instances.shieldedInstanceConfigObjectThe Shielded VM configuration for the instance.
GCP.Compute.Instances.sourceMachineImageEncryptionKeyObjectThe source machine image encryption key used when creating an instance from a machine image.
GCP.Compute.Instances.confidentialInstanceConfigObjectThe confidential computing configuration for the instance.
GCP.Compute.Instances.fingerprintStringThe fingerprint for the resource, which is a hash of the instance contents used for optimistic locking.
GCP.Compute.Instances.privateIpv6GoogleAccessStringThe private IPv6 Google access type for the VM.
GCP.Compute.Instances.advancedMachineFeaturesObjectThe controls for the advanced machine-related behavior features.
GCP.Compute.Instances.lastStartTimestampStringLast start timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Instances.lastStopTimestampStringLast stop timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Instances.lastSuspendedTimestampStringLast suspended timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Instances.satisfiesPzsStringIndicates whether the instance satisfies physical zone separation requirements.
GCP.Compute.Instances.satisfiesPziStringIndicates whether the instance satisfies physical zone isolation requirements.
GCP.Compute.Instances.resourceStatusObjectThe resource status.
GCP.Compute.Instances.networkPerformanceConfigObjectThe network performance configuration.
GCP.Compute.Instances.keyRevocationActionTypeStringThe KeyRevocationActionType of the instance.
GCP.Compute.AggregatedInstancesNextTokenStringThe token to use to retrieve the next page of aggregated instances results.

gcp-compute-instance-machine-type-set#


Changes the machine type of a stopped Compute Engine VM instance. Returns a zone Operation resource describing the asynchronous update. Required permission: compute.instances.setMachineType.

Base Command#

gcp-compute-instance-machine-type-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the instance resource for which to set the machine type.Required
machine_typeThe machine type. Can be a bare name (for example, n1-standard-1), in which case the zone-qualified URL is built automatically, or a full/partial URL (for example, zones/zone/machineTypes/n1-standard-1).Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe server-defined unique identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides, available only for per-zone operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of requestId, if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete, and so on.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberAn optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe time that this operation was completed. This value is in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorstringThe errors generated during the operation.
GCP.Compute.Operations.warningsstringThe warning messages generated during the operation.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails (for example, 404 if the resource is not found).
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails (for example, NOT FOUND).
GCP.Compute.Operations.selfLinkstringThe server-defined resource URL.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides, available only for regional operations. This must be specified in the HTTP request URL and is not configurable in the request body.
GCP.Compute.Operations.descriptionstringA textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringType of the resource. Always compute#operation for Operation resources.

gcp-compute-image-delete#


Deletes the specified image. Required permission: compute.images.delete.

Base Command#

gcp-compute-image-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
imageThe name of the image resource to delete.Required

Context Output#

There is no context output for this command.

gcp-compute-images-list#


Lists images in a specific project. Required permission: compute.images.list.

Base Command#

gcp-compute-images-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return. Can be 1 to 500. Default is 50.Optional
next_tokenThe token for the next set of items to return, used for pagination.Optional
filterThe filter expression for resources listed in the response. Must specify a field name, a comparison operator (=, !=, >, or <), and a value.Optional
order_byThe order used to sort list results. By default, results are returned in alphanumeric order based on the resource name.Optional

Context Output#

PathTypeDescription
GCP.Compute.Images.kindStringThe type of the resource. Always set to compute#image for images.
GCP.Compute.Images.idStringThe unique identifier for the resource, defined by the server.
GCP.Compute.Images.creationTimestampDateThe creation timestamp in RFC3339 format.
GCP.Compute.Images.nameStringThe name of the resource, provided by the client when the resource is created.
GCP.Compute.Images.descriptionStringThe optional description of this resource.
GCP.Compute.Images.sourceTypeStringThe type of image used to create this disk. The default and only value is RAW.
GCP.Compute.Images.rawDisk.sourceStringThe full Google Cloud Storage URL where the disk image is stored.
GCP.Compute.Images.rawDisk.sha1ChecksumStringThe optional SHA1 checksum of the disk image before unpackaging, provided by the client when the disk image is created.
GCP.Compute.Images.rawDisk.containerTypeStringThe format used to encode and transmit the block device, which should be TAR.
GCP.Compute.Images.deprecated.stateStringThe deprecation state of this resource. Can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED.
GCP.Compute.Images.deprecated.replacementStringThe URL of the suggested replacement for a deprecated resource.
GCP.Compute.Images.deprecated.deprecatedDateThe RFC3339 timestamp on or after which the state of this resource changes to DEPRECATED.
GCP.Compute.Images.deprecated.obsoleteDateThe RFC3339 timestamp on or after which the state of this resource changes to OBSOLETE.
GCP.Compute.Images.deprecated.deletedDateThe RFC3339 timestamp on or after which the state of this resource changes to DELETED.
GCP.Compute.Images.statusStringThe status of the image. Can be FAILED, PENDING, or READY.
GCP.Compute.Images.archiveSizeBytesStringThe size, in bytes, of the image tar.gz archive stored in Google Cloud Storage.
GCP.Compute.Images.diskSizeGbStringThe size, in GB, of the image when restored onto a persistent disk.
GCP.Compute.Images.sourceDiskStringThe URL of the source disk used to create this image.
GCP.Compute.Images.sourceDiskIdStringThe ID value of the disk used to create this image.
GCP.Compute.Images.sourceDiskEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source disk that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceDiskEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source disk.
GCP.Compute.Images.sourceImageStringThe URL of the source image used to create this image.
GCP.Compute.Images.sourceImageIdStringThe ID value of the image used to create this image.
GCP.Compute.Images.sourceImageEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source image that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceImageEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source image.
GCP.Compute.Images.sourceSnapshotStringThe URL of the source snapshot used to create this image.
GCP.Compute.Images.sourceSnapshotIdStringThe ID value of the snapshot used to create this image.
GCP.Compute.Images.sourceSnapshotEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source snapshot that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceSnapshotEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source snapshot.
GCP.Compute.Images.imageEncryptionKey.kmsKeyNameStringThe name of the encryption key of the image that is stored in Google Cloud KMS.
GCP.Compute.Images.imageEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the image.
GCP.Compute.Images.licensesStringThe applicable license URIs.
GCP.Compute.Images.licenseCodesStringThe integer license codes indicating which licenses are attached to this image.
GCP.Compute.Images.familyStringThe name of the image family to which this image belongs.
GCP.Compute.Images.labelsUnknownThe labels applied to this image.
GCP.Compute.Images.labelFingerprintStringThe fingerprint of the labels applied to this image, which is used for optimistic locking.
GCP.Compute.Images.guestOsFeatures.typeStringThe ID of the supported guest operating system feature.
GCP.Compute.Images.shieldedInstanceInitialStateUnknownThe initial state for the image, which is used by Shielded VM instances on boot.
GCP.Compute.Images.storageLocationsStringThe Cloud Storage location, either regional or multi-regional, where the image content is stored.
GCP.Compute.Images.architectureStringThe architecture of the image. Can be ARM64 or X86_64.
GCP.Compute.Images.enableConfidentialComputeBooleanWhether the image is created from a confidential compute mode disk.
GCP.Compute.Images.satisfiesPzsBooleanWhether the resource satisfies physical zone separation.
GCP.Compute.Images.satisfiesPziBooleanWhether the resource satisfies physical zone isolation.
GCP.Compute.Images.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.ImagesNextTokenStringThe token to use as the next_token argument to retrieve the next page of results.

gcp-compute-image-insert#


Creates an image in the specified project using the data included in the request. Required permission: compute.images.create.

Base Command#

gcp-compute-image-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
nameThe name of the resource; provided by the client when the resource is created.Required
force_createWhether to attempt to create the image even if OS features or license validation fails. Possible values are: true, false.Optional
descriptionThe optional description of this resource.Optional
raw_disk_sourceThe full Google Cloud Storage URL where the disk image is stored.Optional
raw_disk_sha1_checksumThe optional SHA1 checksum of the disk image before unpackaging.Optional
raw_disk_container_typeThe format used to encode and transmit the block device, which should be TAR. Possible values are: TAR.Optional
deprecated_stateThe deprecation state of this resource. Can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Possible values are: ACTIVE, DEPRECATED, OBSOLETE, DELETED.Optional
deprecated_replacementThe URL of the suggested replacement for a deprecated resource.Optional
archive_size_bytesThe size, in bytes, of the image tar.gz archive stored in Google Cloud Storage.Optional
disk_size_gbThe size, in GB, of the image when restored onto a persistent disk.Optional
source_diskThe URL of the source disk used to create this image. This property or the raw_disk_source property must be provided, but not both.Optional
licensesA comma-separated list of applicable license URIs.Optional
familyThe name of the image family to which this image belongs.Optional
image_encryption_key_raw_keyThe 256-bit customer-supplied encryption key (RFC 4648 base64) for the image.Optional
image_encryption_key_kms_key_nameThe name of the encryption key that is stored in Google Cloud KMS for the image.Optional
source_disk_encryption_key_raw_keyThe 256-bit customer-supplied encryption key (RFC 4648 base64) of the source disk.Optional
source_disk_encryption_key_kms_key_nameThe name of the encryption key stored in Google Cloud KMS of the source disk.Optional
labelsThe list of labels to apply for this resource, in tuples, for example, key=abc,value=123;key=def,value=456.Optional
label_fingerprintThe fingerprint of the previous set of labels for this resource.Optional
guest_os_featuresThe comma-separated list of guest OS features to enable on the image.Optional
license_codesThe comma-separated list of integer license codes indicating which licenses are attached to this image.Optional
source_imageThe URL of the source image used to create this image.Optional
source_image_encryption_key_kms_key_nameThe name of the encryption key stored in Google Cloud KMS of the source image.Optional
source_snapshotThe URL of the source snapshot used to create this image.Optional
source_snapshot_encryption_key_raw_keyThe 256-bit customer-supplied encryption key (RFC 4648 base64) of the source snapshot.Optional
source_snapshot_encryption_key_kms_key_nameThe name of the encryption key stored in Google Cloud KMS of the source snapshot.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.kindStringThe type of the resource. Always set to compute#operation for operation resources.
GCP.Compute.Operations.idStringThe unique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides. Only available when performing per-zone operations.
GCP.Compute.Operations.clientOperationIdStringThe value of requestId if it was provided in the request.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Can be PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example EMAILADDRESS.
GCP.Compute.Operations.progressNumberThe progress of the operation as a percentage from 0 to 100.
GCP.Compute.Operations.insertTimeDateThe time the operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimeDateThe time the operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimeDateThe time the operation was completed, in RFC3339 format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during the processing of the operation.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code returned if the operation fails.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only available when performing regional operations.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.

gcp-compute-image-labels-set#


Sets the labels on an image. Required permission: compute.images.setLabels.

Base Command#

gcp-compute-image-labels-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
imageThe name of the image resource on which to set labels.Required
labelsThe list of labels to apply to this resource, formatted as tuples, for example, key=abc,value=123;key=def,value=456.Required
label_fingerprintThe fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.kindStringThe type of the resource. Always set to compute#operation for operation resources.
GCP.Compute.Operations.idStringThe unique identifier for the operation resource, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides. Only available when performing per-zone operations.
GCP.Compute.Operations.clientOperationIdStringThe value of the requestId if provided in the request.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Can be PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example EMAILADDRESS.
GCP.Compute.Operations.progressNumberThe progress of the operation as a percentage from 0 to 100.
GCP.Compute.Operations.insertTimeDateThe time the operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimeDateThe time the operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimeDateThe time the operation was completed, in RFC3339 format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during the processing of the operation.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code returned if the operation fails.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only available when performing regional operations.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.

gcp-compute-image-get-from-family#


Returns the latest non-deprecated image from an image family. Required permission: compute.images.get.

Base Command#

gcp-compute-image-get-from-family

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
familyThe name of the image family to search for.Required

Context Output#

PathTypeDescription
GCP.Compute.Images.kindStringThe type of the resource. Always set to compute#image for images.
GCP.Compute.Images.idStringThe unique identifier for the resource, defined by the server.
GCP.Compute.Images.creationTimestampDateThe creation timestamp in RFC3339 format.
GCP.Compute.Images.nameStringThe name of the resource, provided by the client when the resource is created.
GCP.Compute.Images.descriptionStringThe optional description of this resource.
GCP.Compute.Images.sourceTypeStringThe type of image used to create this disk. The default and only value is RAW.
GCP.Compute.Images.rawDisk.sourceStringThe full Google Cloud Storage URL where the disk image is stored.
GCP.Compute.Images.rawDisk.sha1ChecksumStringThe optional SHA1 checksum of the disk image before unpackaging, provided by the client when the disk image is created.
GCP.Compute.Images.rawDisk.containerTypeStringThe format used to encode and transmit the block device, which should be TAR.
GCP.Compute.Images.deprecated.stateStringThe deprecation state of this resource. Can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED.
GCP.Compute.Images.deprecated.replacementStringThe URL of the suggested replacement for a deprecated resource.
GCP.Compute.Images.deprecated.deprecatedDateThe RFC3339 timestamp on or after which the state of this resource changes to DEPRECATED.
GCP.Compute.Images.deprecated.obsoleteDateThe RFC3339 timestamp on or after which the state of this resource changes to OBSOLETE.
GCP.Compute.Images.deprecated.deletedDateThe RFC3339 timestamp on or after which the state of this resource changes to DELETED.
GCP.Compute.Images.statusStringThe status of the image. Can be FAILED, PENDING, or READY.
GCP.Compute.Images.archiveSizeBytesStringThe size, in bytes, of the tar.gz image archive stored in Google Cloud Storage.
GCP.Compute.Images.diskSizeGbStringThe size of the image in GB when restored onto a persistent disk.
GCP.Compute.Images.sourceDiskStringThe URL of the source disk used to create this image.
GCP.Compute.Images.sourceDiskIdStringThe ID value of the disk used to create this image.
GCP.Compute.Images.sourceDiskEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source disk that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceDiskEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source disk.
GCP.Compute.Images.sourceImageStringThe URL of the source image used to create this image.
GCP.Compute.Images.sourceImageIdStringThe ID value of the image used to create this image.
GCP.Compute.Images.sourceImageEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source image that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceImageEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source image.
GCP.Compute.Images.sourceSnapshotStringThe URL of the source snapshot used to create this image.
GCP.Compute.Images.sourceSnapshotIdStringThe ID value of the snapshot used to create this image.
GCP.Compute.Images.sourceSnapshotEncryptionKey.kmsKeyNameStringThe name of the encryption key of the source snapshot that is stored in Google Cloud KMS.
GCP.Compute.Images.sourceSnapshotEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the source snapshot.
GCP.Compute.Images.imageEncryptionKey.kmsKeyNameStringThe name of the encryption key of the image that is stored in Google Cloud KMS.
GCP.Compute.Images.imageEncryptionKey.sha256StringThe RFC 4648 base64-encoded SHA-256 hash of the customer-supplied encryption key that protects the image.
GCP.Compute.Images.licensesStringThe applicable license URIs.
GCP.Compute.Images.licenseCodesStringThe integer license codes indicating which licenses are attached to this image.
GCP.Compute.Images.familyStringThe name of the image family to which this image belongs.
GCP.Compute.Images.labelsUnknownThe labels applied to this image.
GCP.Compute.Images.labelFingerprintStringThe fingerprint of the labels applied to this image, which is used for optimistic locking.
GCP.Compute.Images.guestOsFeatures.typeStringThe ID of the supported guest operating system feature.
GCP.Compute.Images.shieldedInstanceInitialStateUnknownThe initial state for the image, which is used by Shielded VM instances on boot.
GCP.Compute.Images.storageLocationsStringThe Cloud Storage location, either regional or multi-regional, where the image content is stored.
GCP.Compute.Images.architectureStringThe architecture of the image. Can be ARM64 or X86_64.
GCP.Compute.Images.enableConfidentialComputeBooleanWhether the image is created from a confidential compute mode disk.
GCP.Compute.Images.satisfiesPzsBooleanWhether the resource satisfies physical zone separation.
GCP.Compute.Images.satisfiesPziBooleanWhether the resource satisfies physical zone isolation.
GCP.Compute.Images.selfLinkStringThe server-defined URL for the resource.

gcp-compute-network-delete#


Deletes the specified network. Required permission: compute.networks.delete.

Base Command#

gcp-compute-network-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
networkThe name of the network to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique server-defined identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe progress indicator, ranging from 0 to 100. There is no requirement that this be linear or support any granularity of operations. Must not be used to guess when the operation will be completed. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.errorstringThe errors generated during processing of the operation, if any. Populated when errors occur.
GCP.Compute.Operations.warningsstringThe warning messages generated during processing of the operation, if any. Populated when warnings occur.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-network-peering-add#


Adds a peering connection to the specified network. Required permission: compute.networks.addPeering.

Base Command#

gcp-compute-network-peering-add

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
networkThe name of the network resource to which to add a peering connection.Required
nameThe name of the peering connection. The name must comply with RFC1035 (the Internet standard for domain name syntax and conventions). Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.Required
peer_networkThe URL of the peer network. Can be a full URL or a partial URL. The peer network can belong to a different project. If the partial URL does not contain a project, the peer network is assumed to be in the same project as the current network.Required
exchange_subnet_routesWhether full mesh connectivity is created and managed automatically between peered networks. Currently, this field should always be set to true because Google Compute Engine automatically creates and manages subnetwork routes between two networks when the peering state is ACTIVE. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique server-defined identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe progress indicator, ranging from 0 to 100. There is no requirement that this be linear or support any granularity of operations. Must not be used to guess when the operation will be completed. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimestringThe date and time when the operation was requested, in RFC3339 format; for example, 2024-01-15T12:34:56Z.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.errorstringThe errors generated during processing of the operation, if any. Populated when errors occur.
GCP.Compute.Operations.warningsstringThe warning messages generated during processing of the operation, if any. Populated when warnings occur.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-network-peering-remove#


Removes a peering connection from the specified network. Required permission: compute.networks.removePeering.

Base Command#

gcp-compute-network-peering-remove

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
networkThe name of the network resource from which to remove the peering connection.Required
nameThe name of the peering connection to remove. The name must comply with RFC1035 (the Internet standard for domain name syntax and conventions). Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique server-defined identifier for the resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides. Only available when performing per-zone operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.clientOperationIdstringThe value of the requestId if provided in the request.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk from which the snapshot was created.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING RUNNING or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe progress indicator, ranging from 0 to 100. There is no requirement that this be linear or support any granularity of operations. Must not be used to guess when the operation will be completed. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimestringThe time that this operation was requested, in RFC3339 format.
GCP.Compute.Operations.startTimestringThe time that this operation was started by the server, in RFC3339 format.
GCP.Compute.Operations.endTimestringThe time that this operation was completed, in RFC3339 format.
GCP.Compute.Operations.errorstringThe errors generated during processing of the operation, if any. Populated when errors occur.
GCP.Compute.Operations.warningsstringThe warning messages generated during processing of the operation, if any. Populated when warnings occur.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails. For example, a 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations. Must be specified as part of the HTTP request URL and cannot be set as a field in the request body.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource, which is always compute#operation for Operation resources.

gcp-compute-global-address-get#


Returns the specified global address resource. Required permission: compute.globalAddresses.get.

Base Command#

gcp-compute-global-address-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
addressThe name of the address resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Addresses.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Addresses.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Addresses.namestringThe name of the resource.
GCP.Compute.Addresses.descriptionstringThe optional description of this resource.
GCP.Compute.Addresses.addressstringThe static IP address represented by this resource.
GCP.Compute.Addresses.prefixLengthnumberThe prefix length if the resource represents an IP range.
GCP.Compute.Addresses.statusstringThe status of the address. Possible values are RESERVING, RESERVED, or IN_USE.
GCP.Compute.Addresses.usersstringThe URLs of the resources that are using this address.
GCP.Compute.Addresses.networkTierstringThe networking tier used for configuring this address. Possible values are PREMIUM or STANDARD.
GCP.Compute.Addresses.addressTypestringThe type of address to reserve. Possible values are INTERNAL or EXTERNAL.
GCP.Compute.Addresses.purposestringThe purpose of this resource, which can be used for network load balancing or other purposes.
GCP.Compute.Addresses.subnetworkstringThe URL of the subnetwork in which to reserve the address.
GCP.Compute.Addresses.ipv6EndpointTypestringThe endpoint type of this address, which can be VM or NETLB. Used to decide which type of endpoint this address can be used for after the external IPv6 address reservation.
GCP.Compute.Addresses.labelsUnknownThe labels applied to this resource. These can only be added or modified by the setLabels method.
GCP.Compute.Addresses.labelFingerprintstringThe fingerprint for the labels applied to this address, used for optimistic locking. Provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Addresses.networkstringThe URL of the network in which to reserve the address.
GCP.Compute.Addresses.ipCollectionstringThe URL of the source of external IPv4 addresses, such as a public delegated prefix (PDP) used for bring your own IP (BYOIP).
GCP.Compute.Addresses.ipVersionstringThe IP version that will be used by this address.
GCP.Compute.Addresses.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Addresses.kindstringThe type of the resource. Always compute#address for addresses.

gcp-compute-global-address-list#


Retrieves the list of global address resources. Required permission: compute.globalAddresses.list.

Base Command#

gcp-compute-global-address-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
filterThe filter expression that filters resources listed in the response.Optional
order_byThe order by which to sort list results. By default, results are returned in alphanumerical order based on the resource name.Optional
next_tokenThe token for the next set of items to return, used for pagination. Set this to the value of GCP.Compute.GlobalAddressesNextToken returned by a previous list request.Optional

Context Output#

PathTypeDescription
GCP.Compute.Addresses.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Addresses.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Addresses.namestringThe name of the resource.
GCP.Compute.Addresses.descriptionstringThe optional description of this resource.
GCP.Compute.Addresses.addressstringThe static IP address represented by this resource.
GCP.Compute.Addresses.prefixLengthnumberThe prefix length if the resource represents an IP range.
GCP.Compute.Addresses.statusstringThe status of the address. Possible values are RESERVING, RESERVED, or IN_USE.
GCP.Compute.Addresses.usersstringThe URLs of the resources that are using this address.
GCP.Compute.Addresses.networkTierstringThe networking tier used for configuring this address. Possible values are PREMIUM or STANDARD.
GCP.Compute.Addresses.addressTypestringThe type of address to reserve. Possible values are INTERNAL or EXTERNAL.
GCP.Compute.Addresses.purposestringThe purpose of this resource, which can be used for network load balancing or other purposes.
GCP.Compute.Addresses.subnetworkstringThe URL of the subnetwork in which to reserve the address.
GCP.Compute.Addresses.ipVersionstringThe IP version used by this address. Possible values are IPV4 or IPV6.
GCP.Compute.Addresses.ipv6EndpointTypestringThe endpoint type of this address, which can be VM or NETLB. Used to decide which type of endpoint this address can be used for after the external IPv6 address reservation.
GCP.Compute.Addresses.labelsUnknownThe labels applied to this resource. These can only be added or modified by the setLabels method.
GCP.Compute.Addresses.labelFingerprintstringThe fingerprint for the labels applied to this address, used for optimistic locking. Provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Addresses.networkstringThe URL of the network in which to reserve the address.
GCP.Compute.Addresses.ipCollectionstringThe URL of the source of external IPv4 addresses, such as a public delegated prefix (PDP) used for bring your own IP (BYOIP).
GCP.Compute.Addresses.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Addresses.kindstringThe type of the resource. Always compute#address for addresses.
GCP.Compute.GlobalAddressesNextTokenstringThe token used to retrieve the next page of results for list requests.

gcp-compute-address-insert#


Creates a regional address resource in the specified project using the data included in the request. Required permission: compute.addresses.create.

Base Command#

gcp-compute-address-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
nameThe name of the address resource to create.Required
descriptionThe optional description of this resource.Optional
addressThe static IP address to reserve. If not specified, an unused ephemeral IP address is assigned.Optional
prefix_lengthThe prefix length if the resource represents an IP range.Optional
network_tierThe networking tier used for configuring this address. Possible values are: PREMIUM, STANDARD.Optional
address_typeThe type of address to reserve. Possible values are: INTERNAL, EXTERNAL.Optional
purposeThe purpose of this resource, such as GCE_ENDPOINT, SHARED_LOADBALANCER_VIP, or VPC_PEERING.Optional
subnetworkThe URL of the subnetwork in which to reserve the address. Required if the address type is INTERNAL.Optional
networkThe URL of the network in which to reserve the address.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.clientOperationIdstringThe value of the request ID if provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, if any.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, if any.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails. For example, 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-global-address-insert#


Creates a global address resource in the specified project using the data included in the request. Required permission: compute.globalAddresses.create.

Base Command#

gcp-compute-global-address-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
nameThe name of the address resource to create.Required
descriptionThe optional description of this resource.Optional
addressThe static IP address to reserve. If not specified, an unused ephemeral IP address is assigned.Optional
prefix_lengthThe prefix length if the resource represents an IP range.Optional
network_tierThe networking tier used for configuring this address. Possible values are: PREMIUM, STANDARD.Optional
ip_versionThe IP version that will be used by this address. Possible values are: IPV4, IPV6.Optional
address_typeThe type of address to reserve. Possible values are: INTERNAL, EXTERNAL.Optional
purposeThe purpose of this resource, such as GCE_ENDPOINT, SHARED_LOADBALANCER_VIP, or VPC_PEERING.Optional
subnetworkThe URL of the subnetwork in which to reserve the address. Required if the address type is INTERNAL.Optional
networkThe URL of the network in which to reserve the address.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.clientOperationIdstringThe value of the request ID if provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, if any.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, if any.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails. For example, 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-address-aggregated-list#


Retrieves an aggregated list of regional address resources across all regions. Required permission: compute.addresses.list.

Base Command#

gcp-compute-address-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
filterThe filter expression that filters resources listed in the response.Optional
order_byThe order by which to sort list results. By default, results are returned in alphanumerical order based on the resource name.Optional
next_tokenThe token for the next set of items to return, used for pagination. Set this to the value of GCP.Compute.AggregatedAddressesNextToken returned by a previous list request.Optional

Context Output#

PathTypeDescription
GCP.Compute.Addresses.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Addresses.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Addresses.namestringThe name of the resource.
GCP.Compute.Addresses.descriptionstringThe optional description of this resource.
GCP.Compute.Addresses.addressstringThe static IP address represented by this resource.
GCP.Compute.Addresses.prefixLengthnumberThe prefix length if the resource represents an IP range.
GCP.Compute.Addresses.statusstringThe status of the address. Possible values are RESERVING, RESERVED, or IN_USE.
GCP.Compute.Addresses.regionstringThe URL of the region where a regional address resides.
GCP.Compute.Addresses.usersstringThe URLs of the resources that are using this address.
GCP.Compute.Addresses.networkTierstringThe networking tier used for configuring this address. Possible values are PREMIUM or STANDARD.
GCP.Compute.Addresses.addressTypestringThe type of address to reserve. Possible values are INTERNAL or EXTERNAL.
GCP.Compute.Addresses.purposestringThe purpose of this resource, which can be used for network load balancing or other purposes.
GCP.Compute.Addresses.subnetworkstringThe URL of the subnetwork in which to reserve the address.
GCP.Compute.Addresses.ipVersionstringThe IP version used by this address. Possible values are IPV4 or IPV6.
GCP.Compute.Addresses.ipv6EndpointTypestringThe endpoint type of this address, which can be VM or NETLB. Used to decide which type of endpoint this address can be used for after the external IPv6 address reservation.
GCP.Compute.Addresses.labelsUnknownThe labels applied to this resource. These can only be added or modified by the setLabels method.
GCP.Compute.Addresses.labelFingerprintstringThe fingerprint for the labels applied to this address, used for optimistic locking. Provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Addresses.networkstringThe URL of the network in which to reserve the address.
GCP.Compute.Addresses.ipCollectionstringThe URL of the source of external IPv4 addresses, such as a public delegated prefix (PDP) used for bring your own IP (BYOIP).
GCP.Compute.Addresses.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Addresses.kindstringThe type of the resource. Always compute#address for addresses.
GCP.Compute.AggregatedAddressesNextTokenstringThe token used to retrieve the next page of results for list requests.

gcp-compute-address-delete#


Deletes the specified regional address resource. Required permission: compute.addresses.delete.

Base Command#

gcp-compute-address-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
addressThe name of the address resource to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.clientOperationIdstringThe value of the request ID if provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, if any.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, if any.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails. For example, 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.regionstringThe URL of the region where the operation resides. Only available when performing regional operations.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-address-get#


Returns the specified regional address resource. Required permission: compute.addresses.get.

Base Command#

gcp-compute-address-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
addressThe name of the address resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Addresses.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Addresses.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Addresses.namestringThe name of the resource.
GCP.Compute.Addresses.descriptionstringThe optional description of this resource.
GCP.Compute.Addresses.addressstringThe static IP address represented by this resource.
GCP.Compute.Addresses.prefixLengthnumberThe prefix length if the resource represents an IP range.
GCP.Compute.Addresses.statusstringThe status of the address. Possible values are RESERVING, RESERVED, or IN_USE.
GCP.Compute.Addresses.regionstringThe URL of the region where a regional address resides.
GCP.Compute.Addresses.usersstringThe URLs of the resources that are using this address.
GCP.Compute.Addresses.networkTierstringThe networking tier used for configuring this address. Possible values are PREMIUM or STANDARD.
GCP.Compute.Addresses.addressTypestringThe type of address to reserve. Possible values are INTERNAL or EXTERNAL.
GCP.Compute.Addresses.purposestringThe purpose of this resource, which can be used for network load balancing or other purposes.
GCP.Compute.Addresses.subnetworkstringThe URL of the subnetwork in which to reserve the address.
GCP.Compute.Addresses.ipv6EndpointTypestringThe endpoint type of this address, which can be VM or NETLB. Used to decide which type of endpoint this address can be used for after the external IPv6 address reservation.
GCP.Compute.Addresses.labelsUnknownThe labels applied to this resource. These can only be added or modified by the setLabels method.
GCP.Compute.Addresses.labelFingerprintstringThe fingerprint for the labels applied to this address, used for optimistic locking. Provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Addresses.networkstringThe URL of the network in which to reserve the address.
GCP.Compute.Addresses.ipCollectionstringThe URL of the source of external IPv4 addresses, such as a public delegated prefix (PDP) used for bring your own IP (BYOIP).
GCP.Compute.Addresses.ipVersionstringThe IP version that will be used by this address.
GCP.Compute.Addresses.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Addresses.kindstringThe type of the resource. Always compute#address for addresses.

gcp-compute-address-list#


Retrieves the list of regional address resources in the specified region. Required permission: compute.addresses.list.

Base Command#

gcp-compute-address-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
filterThe filter expression that filters resources listed in the response.Optional
order_byThe order by which to sort list results. By default, results are returned in alphanumerical order based on the resource name.Optional
next_tokenThe token for the next set of items to return, used for pagination. Set this to the value of GCP.Compute.AddressesNextToken returned by a previous list request.Optional

Context Output#

PathTypeDescription
GCP.Compute.Addresses.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Addresses.creationTimestampstringThe creation timestamp in RFC3339 text format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Addresses.namestringThe name of the resource.
GCP.Compute.Addresses.descriptionstringThe optional description of this resource.
GCP.Compute.Addresses.addressstringThe static IP address represented by this resource.
GCP.Compute.Addresses.prefixLengthnumberThe prefix length if the resource represents an IP range.
GCP.Compute.Addresses.statusstringThe status of the address. Possible values are RESERVING, RESERVED, or IN_USE.
GCP.Compute.Addresses.regionstringThe URL of the region where a regional address resides.
GCP.Compute.Addresses.usersstringThe URLs of the resources that are using this address.
GCP.Compute.Addresses.networkTierstringThe networking tier used for configuring this address. Possible values are PREMIUM or STANDARD.
GCP.Compute.Addresses.addressTypestringThe type of address to reserve. Possible values are INTERNAL or EXTERNAL.
GCP.Compute.Addresses.purposestringThe purpose of this resource, which can be used for network load balancing or other purposes.
GCP.Compute.Addresses.subnetworkstringThe URL of the subnetwork in which to reserve the address.
GCP.Compute.Addresses.ipVersionstringThe IP version used by this address. Possible values are IPV4 or IPV6.
GCP.Compute.Addresses.ipv6EndpointTypestringThe endpoint type of this address, which can be VM or NETLB. Used to decide which type of endpoint this address can be used for after the external IPv6 address reservation.
GCP.Compute.Addresses.labelsUnknownThe labels applied to this resource. These can only be added or modified by the setLabels method.
GCP.Compute.Addresses.labelFingerprintstringThe fingerprint for the labels applied to this address, used for optimistic locking. Provide an up-to-date fingerprint hash in order to update or change labels.
GCP.Compute.Addresses.networkstringThe URL of the network in which to reserve the address.
GCP.Compute.Addresses.ipCollectionstringThe URL of the source of external IPv4 addresses, such as a public delegated prefix (PDP) used for bring your own IP (BYOIP).
GCP.Compute.Addresses.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Addresses.kindstringThe type of the resource. Always compute#address for addresses.
GCP.Compute.AddressesNextTokenstringThe token used to retrieve the next page of results for list requests.

gcp-compute-global-address-delete#


Deletes the specified global address resource. Required permission: compute.globalAddresses.delete.

Base Command#

gcp-compute-global-address-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
addressThe name of the address resource to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the resource, defined by the server.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.clientOperationIdstringThe value of the request ID if provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation, for example, EMAILADDRESS.
GCP.Compute.Operations.progressnumberThe optional progress indicator, ranging from 0 to 100.
GCP.Compute.Operations.insertTimestringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimestringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimestringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, if any.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, if any.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code returned if the operation fails. For example, 404 means the resource was not found.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionstringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.kindstringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-disks-list#


Retrieves a list of persistent disks contained within the specified zone. Required permission: compute.disks.list.

Base Command#

gcp-compute-disks-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
next_tokenThe token for pagination. Set it to the value of GCP.Compute.DisksNextToken returned by a previous request to get the next page of results.Optional
filterThe filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a disk named example-disk, use name != example-disk.Optional
order_byThe order in which to sort the list results. By default, results are returned in alphanumerical order based on the resource name. Results can also be sorted in descending order based on the creation timestamp using creationTimestamp desc.Optional

Context Output#

PathTypeDescription
GCP.Compute.Disks.idStringThe unique identifier for the disk resource.
GCP.Compute.Disks.nameStringThe name of the disk resource.
GCP.Compute.Disks.kindStringThe type of the resource, for example compute#disk.
GCP.Compute.Disks.descriptionStringThe optional description of the disk.
GCP.Compute.Disks.statusStringThe status of disk creation, such as READY or CREATING.
GCP.Compute.Disks.sizeGbStringThe size of the persistent disk, specified in GB.
GCP.Compute.Disks.typeStringThe URL of the disk type resource describing which disk type is used by this disk.
GCP.Compute.Disks.zoneStringThe URL of the zone where the disk resides.
GCP.Compute.Disks.regionStringThe URL of the region where the disk resides. Only applicable for regional resources.
GCP.Compute.Disks.creationTimestampDateThe creation timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastAttachTimestampDateThe last attach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastDetachTimestampDateThe last detach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.usersUnknownThe links to the instances to which the disk is attached.
GCP.Compute.Disks.licensesUnknownThe list of publicly visible licenses attached to the disk.
GCP.Compute.Disks.licenseCodesUnknownThe integer license codes indicating which licenses are attached to the disk.
GCP.Compute.Disks.guestOsFeaturesUnknownThe list of features to enable on the guest operating system, each containing a type field.
GCP.Compute.Disks.labelsUnknownThe labels applied to the disk as key-value pairs.
GCP.Compute.Disks.labelFingerprintStringThe fingerprint for the labels applied to the disk, used for optimistic locking.
GCP.Compute.Disks.sourceImageStringThe source image used to create this disk.
GCP.Compute.Disks.sourceImageIdStringThe ID value of the image used to create this disk.
GCP.Compute.Disks.sourceSnapshotStringThe source snapshot used to create this disk.
GCP.Compute.Disks.sourceSnapshotIdStringThe unique ID of the snapshot used to create this disk.
GCP.Compute.Disks.diskEncryptionKeyUnknownThe customer-supplied encryption key of the disk, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceImageEncryptionKeyUnknownThe customer-supplied encryption key of the source image, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceSnapshotEncryptionKeyUnknownThe customer-supplied encryption key of the source snapshot, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.replicaZonesUnknownThe URLs of the zones where the disk is replicated. Only applicable for regional resources.
GCP.Compute.Disks.physicalBlockSizeBytesStringThe physical block size of the persistent disk, in bytes.
GCP.Compute.Disks.selfLinkStringThe server-defined URL for the disk resource.
GCP.Compute.Disks.accessModeStringThe access mode of the disk, such as READ_WRITE_SINGLE, READ_WRITE_MANY, or READ_ONLY_MANY.
GCP.Compute.Disks.architectureStringThe architecture of the disk. Valid values are ARM64 or X86_64.
GCP.Compute.Disks.asyncPrimaryDiskUnknownThe disk that is asynchronously replicated to this disk, containing the consistencyGroupPolicy and disk fields.
GCP.Compute.Disks.asyncSecondaryDisksUnknownThe list of disks to which this disk is asynchronously replicated.
GCP.Compute.Disks.enableConfidentialComputeBooleanWhether this disk is using confidential compute mode.
GCP.Compute.Disks.locationHintStringThe opaque location hint used to place the disk close to other resources.
GCP.Compute.Disks.optionsStringThe field is reserved for internal use only.
GCP.Compute.Disks.paramsUnknownThe additional parameters used when creating the disk, containing the resourceManagerTags field.
GCP.Compute.Disks.provisionedIopsStringThe number of I/O operations per second provisioned for the disk.
GCP.Compute.Disks.provisionedThroughputStringThe throughput in MB per second provisioned for the disk.
GCP.Compute.Disks.resourcePoliciesUnknownThe resource policies applied to this disk for automatic snapshot creations.
GCP.Compute.Disks.resourceStatusUnknownThe status information for the disk resource.
GCP.Compute.Disks.satisfiesPziBooleanWhether the disk satisfies physical zone isolation. Reserved for future use.
GCP.Compute.Disks.satisfiesPzsBooleanWhether the disk satisfies physical zone separation. Reserved for future use.
GCP.Compute.Disks.sourceConsistencyGroupPolicyStringThe URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceConsistencyGroupPolicyIdStringThe ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceDiskStringThe source disk used to create this disk.
GCP.Compute.Disks.sourceDiskIdStringThe unique ID of the disk used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotStringThe source instant snapshot used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotIdStringThe unique ID of the instant snapshot used to create this disk.
GCP.Compute.Disks.sourceStorageObjectStringThe full Google Cloud Storage URI where the disk image is stored.
GCP.Compute.Disks.storagePoolStringThe storage pool in which the disk is created.
GCP.Compute.DisksNextTokenStringThe token for the next page of results, used for pagination.
GCP.Compute.DisksWarningUnknownThe informational warning returned by the API, containing the code, message, and data fields. For example, NO_RESULTS_ON_PAGE when the page holds no results.

gcp-compute-disks-aggregated-list#


Retrieves an aggregated list of persistent disks across all zones in the project. Required permission: compute.disks.list.

Base Command#

gcp-compute-disks-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
next_tokenThe token for pagination. Set it to the value of GCP.Compute.AggregatedDisksNextToken returned by a previous request to get the next page of results.Optional
filterThe filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a disk named example-disk, use name != example-disk.Optional
order_byThe order in which to sort the list results. By default, results are returned in alphanumerical order based on the resource name. Results can also be sorted in descending order based on the creation timestamp using creationTimestamp desc.Optional

Context Output#

PathTypeDescription
GCP.Compute.Disks.idStringThe unique identifier for the disk resource.
GCP.Compute.Disks.nameStringThe name of the disk resource.
GCP.Compute.Disks.kindStringThe type of the resource, for example compute#disk.
GCP.Compute.Disks.descriptionStringThe optional description of the disk.
GCP.Compute.Disks.statusStringThe status of disk creation, such as READY or CREATING.
GCP.Compute.Disks.sizeGbStringThe size of the persistent disk, specified in GB.
GCP.Compute.Disks.typeStringThe URL of the disk type resource describing which disk type is used by this disk.
GCP.Compute.Disks.zoneStringThe URL of the zone where the disk resides.
GCP.Compute.Disks.regionStringThe URL of the region where the disk resides. Only applicable for regional resources.
GCP.Compute.Disks.creationTimestampDateThe creation timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastAttachTimestampDateThe last attach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastDetachTimestampDateThe last detach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.usersUnknownThe links to the instances to which the disk is attached.
GCP.Compute.Disks.licensesUnknownThe list of publicly visible licenses attached to the disk.
GCP.Compute.Disks.licenseCodesUnknownThe integer license codes indicating which licenses are attached to the disk.
GCP.Compute.Disks.guestOsFeaturesUnknownThe list of features to enable on the guest operating system, each containing a type field.
GCP.Compute.Disks.labelsUnknownThe labels applied to the disk as key-value pairs.
GCP.Compute.Disks.labelFingerprintStringThe fingerprint for the labels applied to the disk, used for optimistic locking.
GCP.Compute.Disks.sourceImageStringThe source image used to create this disk.
GCP.Compute.Disks.sourceImageIdStringThe ID value of the image used to create this disk.
GCP.Compute.Disks.sourceSnapshotStringThe source snapshot used to create this disk.
GCP.Compute.Disks.sourceSnapshotIdStringThe unique ID of the snapshot used to create this disk.
GCP.Compute.Disks.diskEncryptionKeyUnknownThe customer-supplied encryption key of the disk, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceImageEncryptionKeyUnknownThe customer-supplied encryption key of the source image, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceSnapshotEncryptionKeyUnknownThe customer-supplied encryption key of the source snapshot, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.replicaZonesUnknownThe URLs of the zones where the disk is replicated. Only applicable for regional resources.
GCP.Compute.Disks.physicalBlockSizeBytesStringThe physical block size of the persistent disk, in bytes.
GCP.Compute.Disks.selfLinkStringThe server-defined URL for the disk resource.
GCP.Compute.Disks.accessModeStringThe access mode of the disk, such as READ_WRITE_SINGLE, READ_WRITE_MANY, or READ_ONLY_MANY.
GCP.Compute.Disks.architectureStringThe architecture of the disk. Valid values are ARM64 or X86_64.
GCP.Compute.Disks.asyncPrimaryDiskUnknownThe disk that is asynchronously replicated to this disk, containing the consistencyGroupPolicy and disk fields.
GCP.Compute.Disks.asyncSecondaryDisksUnknownThe list of disks to which this disk is asynchronously replicated.
GCP.Compute.Disks.enableConfidentialComputeBooleanWhether this disk is using confidential compute mode.
GCP.Compute.Disks.locationHintStringThe opaque location hint used to place the disk close to other resources.
GCP.Compute.Disks.optionsStringThe field is reserved for internal use only.
GCP.Compute.Disks.paramsUnknownThe additional parameters used when creating the disk, containing the resourceManagerTags field.
GCP.Compute.Disks.provisionedIopsStringThe number of I/O operations per second provisioned for the disk.
GCP.Compute.Disks.provisionedThroughputStringThe throughput in MB per second provisioned for the disk.
GCP.Compute.Disks.resourcePoliciesUnknownThe resource policies applied to this disk for automatic snapshot creations.
GCP.Compute.Disks.resourceStatusUnknownThe status information for the disk resource.
GCP.Compute.Disks.satisfiesPziBooleanWhether the disk satisfies physical zone isolation. Reserved for future use.
GCP.Compute.Disks.satisfiesPzsBooleanWhether the disk satisfies physical zone separation. Reserved for future use.
GCP.Compute.Disks.sourceConsistencyGroupPolicyStringThe URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceConsistencyGroupPolicyIdStringThe ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceDiskStringThe source disk used to create this disk.
GCP.Compute.Disks.sourceDiskIdStringThe unique ID of the disk used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotStringThe source instant snapshot used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotIdStringThe unique ID of the instant snapshot used to create this disk.
GCP.Compute.Disks.sourceStorageObjectStringThe full Google Cloud Storage URI where the disk image is stored.
GCP.Compute.Disks.storagePoolStringThe storage pool in which the disk is created.
GCP.Compute.AggregatedDisksNextTokenStringThe token for the next page of results, used for pagination.
GCP.Compute.AggregatedDisksWarningUnknownThe informational warning returned by the API, containing the code, message, and data fields. For example, NO_RESULTS_ON_PAGE when the page holds no results.

gcp-compute-disk-get#


Returns a specified persistent disk. Required permission: compute.disks.get.

Base Command#

gcp-compute-disk-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the persistent disk to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Disks.idStringThe unique identifier for the disk resource.
GCP.Compute.Disks.nameStringThe name of the disk resource.
GCP.Compute.Disks.kindStringThe type of the resource, for example compute#disk.
GCP.Compute.Disks.descriptionStringThe optional description of the disk.
GCP.Compute.Disks.statusStringThe status of disk creation, such as READY or CREATING.
GCP.Compute.Disks.sizeGbStringThe size of the persistent disk, specified in GB.
GCP.Compute.Disks.typeStringThe URL of the disk type resource describing which disk type is used by this disk.
GCP.Compute.Disks.zoneStringThe URL of the zone where the disk resides.
GCP.Compute.Disks.regionStringThe URL of the region where the disk resides. Only applicable for regional resources.
GCP.Compute.Disks.creationTimestampDateThe creation timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastAttachTimestampDateThe last attach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.lastDetachTimestampDateThe last detach timestamp of the disk in RFC3339 text format.
GCP.Compute.Disks.usersUnknownThe links to the instances to which the disk is attached.
GCP.Compute.Disks.licensesUnknownThe list of publicly visible licenses attached to the disk.
GCP.Compute.Disks.licenseCodesUnknownThe integer license codes indicating which licenses are attached to the disk.
GCP.Compute.Disks.guestOsFeaturesUnknownThe list of features to enable on the guest operating system, each containing a type field.
GCP.Compute.Disks.labelsUnknownThe labels applied to the disk as key-value pairs.
GCP.Compute.Disks.labelFingerprintStringThe fingerprint for the labels applied to the disk, used for optimistic locking.
GCP.Compute.Disks.sourceImageStringThe source image used to create this disk.
GCP.Compute.Disks.sourceImageIdStringThe ID value of the image used to create this disk.
GCP.Compute.Disks.sourceSnapshotStringThe source snapshot used to create this disk.
GCP.Compute.Disks.sourceSnapshotIdStringThe unique ID of the snapshot used to create this disk.
GCP.Compute.Disks.diskEncryptionKeyUnknownThe customer-supplied encryption key of the disk, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceImageEncryptionKeyUnknownThe customer-supplied encryption key of the source image, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.sourceSnapshotEncryptionKeyUnknownThe customer-supplied encryption key of the source snapshot, containing the rawKey, kmsKeyName, and sha256 fields.
GCP.Compute.Disks.replicaZonesUnknownThe URLs of the zones where the disk is replicated. Only applicable for regional resources.
GCP.Compute.Disks.physicalBlockSizeBytesStringThe physical block size of the persistent disk, in bytes.
GCP.Compute.Disks.selfLinkStringThe server-defined URL for the disk resource.
GCP.Compute.Disks.accessModeStringThe access mode of the disk, such as READ_WRITE_SINGLE, READ_WRITE_MANY, or READ_ONLY_MANY.
GCP.Compute.Disks.architectureStringThe architecture of the disk. Valid values are ARM64 or X86_64.
GCP.Compute.Disks.asyncPrimaryDiskUnknownThe disk that is asynchronously replicated to this disk, containing the consistencyGroupPolicy and disk fields.
GCP.Compute.Disks.asyncSecondaryDisksUnknownThe list of disks to which this disk is asynchronously replicated.
GCP.Compute.Disks.enableConfidentialComputeBooleanWhether this disk is using confidential compute mode.
GCP.Compute.Disks.locationHintStringThe opaque location hint used to place the disk close to other resources.
GCP.Compute.Disks.optionsStringThe field is reserved for internal use only.
GCP.Compute.Disks.paramsUnknownThe additional parameters used when creating the disk, containing the resourceManagerTags field.
GCP.Compute.Disks.provisionedIopsStringThe number of I/O operations per second provisioned for the disk.
GCP.Compute.Disks.provisionedThroughputStringThe throughput in MB per second provisioned for the disk.
GCP.Compute.Disks.resourcePoliciesUnknownThe resource policies applied to this disk for automatic snapshot creations.
GCP.Compute.Disks.resourceStatusUnknownThe status information for the disk resource.
GCP.Compute.Disks.satisfiesPziBooleanWhether the disk satisfies physical zone isolation. Reserved for future use.
GCP.Compute.Disks.satisfiesPzsBooleanWhether the disk satisfies physical zone separation. Reserved for future use.
GCP.Compute.Disks.sourceConsistencyGroupPolicyStringThe URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceConsistencyGroupPolicyIdStringThe ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
GCP.Compute.Disks.sourceDiskStringThe source disk used to create this disk.
GCP.Compute.Disks.sourceDiskIdStringThe unique ID of the disk used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotStringThe source instant snapshot used to create this disk.
GCP.Compute.Disks.sourceInstantSnapshotIdStringThe unique ID of the instant snapshot used to create this disk.
GCP.Compute.Disks.sourceStorageObjectStringThe full Google Cloud Storage URI where the disk image is stored.
GCP.Compute.Disks.storagePoolStringThe storage pool in which the disk is created.

gcp-compute-disk-insert#


Creates a persistent disk in the specified project and zone. A disk can be created from a source image, from a source snapshot, or as an empty disk by omitting both. Required permission: compute.disks.create.

Base Command#

gcp-compute-disk-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the disk to create. The name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, meaning the first character must be a lowercase letter and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.Required
disk_typeThe full or partial URL of the disk type resource describing which disk type to use to create the disk. A bare disk type name is not accepted. For example: projects/project/zones/zone/diskTypes/pd-standard or zones/zone/diskTypes/pd-ssd. If not provided, the project default disk type is used.Optional
size_gbThe size of the persistent disk, specified in GB. Acceptable values are 1 to 65536, inclusive. When specified together with source_image or source_snapshot, the value must not be less than the size of the source.Optional
descriptionThe optional description of the disk.Optional
source_snapshotThe source snapshot used to create this disk, provided as a partial or full URL to the resource.Optional
source_imageThe source image used to create this disk, provided as a partial or full URL to the resource.Optional
licensesThe comma-separated list of publicly visible licenses to attach to the disk.Optional
guest_os_featuresThe comma-separated list of features to enable on the guest operating system. Applicable only for bootable images.Optional
disk_encryption_key_raw_keyThe 256-bit customer-supplied encryption key, encoded in RFC 4648 base64, used to encrypt or decrypt this disk.Optional
disk_encryption_key_kms_key_nameThe name of the encryption key for this disk that is stored in Google Cloud KMS.Optional
source_image_encryption_key_raw_keyThe 256-bit customer-supplied encryption key of the source image, encoded in RFC 4648 base64.Optional
source_image_encryption_key_kms_key_nameThe name of the encryption key of the source image that is stored in Google Cloud KMS.Optional
source_snapshot_encryption_key_raw_keyThe 256-bit customer-supplied encryption key of the source snapshot, encoded in RFC 4648 base64.Optional
source_snapshot_encryption_key_kms_key_nameThe name of the encryption key of the source snapshot that is stored in Google Cloud KMS.Optional
labelsThe labels to apply to this disk, in the format key=abc,value=123;key=def,value=456.Optional
label_fingerprintThe fingerprint of the labels being applied to this disk, used for optimistic locking. An up-to-date fingerprint hash must always be provided, otherwise the request fails with error 412 conditionNotMet.Optional
replica_zonesThe comma-separated list of URLs of the zones where the disk should be replicated. Only applicable for regional resources.Optional
license_codesThe comma-separated list of integer license codes indicating which licenses are attached to this disk.Optional
physical_block_size_bytesThe physical block size of the persistent disk, in bytes. If not provided, a default value is used. Currently supported sizes are 4096 and 16384.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.progressNumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time that this operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeDateThe time that this operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeDateThe time that this operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors list with the code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warnings generated during processing of the operation, each containing the code, message, and data fields.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example 404 when the resource was not found.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulk request.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example user@example.com.

gcp-compute-disk-delete#


Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. Snapshots previously created from the disk are not deleted and must be deleted separately. Required permission: compute.disks.delete.

Base Command#

gcp-compute-disk-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the persistent disk to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.progressNumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time that this operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeDateThe time that this operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeDateThe time that this operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors list with the code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warnings generated during processing of the operation, each containing the code, message, and data fields.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example 404 when the resource was not found.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulk request.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example user@example.com.

gcp-compute-disk-resize#


Resizes the specified persistent disk. The disk size can only be increased. Required permission: compute.disks.resize.

Base Command#

gcp-compute-disk-resize

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the persistent disk to resize.Required
size_gbThe new size of the persistent disk, specified in GB.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.progressNumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time that this operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeDateThe time that this operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeDateThe time that this operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors list with the code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warnings generated during processing of the operation, each containing the code, message, and data fields.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example 404 when the resource was not found.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulk request.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example user@example.com.

gcp-compute-disk-labels-set#


Sets the labels on a persistent disk. Required permission: compute.disks.setLabels.

Base Command#

gcp-compute-disk-labels-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the persistent disk to set the labels on.Required
labelsThe labels to set for this disk, in the format key=abc,value=123;key=def,value=456.Required
label_fingerprintThe fingerprint of the previous set of labels for this disk, used to detect conflicts. Run gcp-compute-disk-get to retrieve the latest fingerprint.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.progressNumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time that this operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeDateThe time that this operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeDateThe time that this operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors list with the code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warnings generated during processing of the operation, each containing the code, message, and data fields.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example 404 when the resource was not found.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulk request.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example user@example.com.

gcp-compute-disk-snapshot-create#


Creates a snapshot of a specified persistent disk. Required permissions: compute.disks.createSnapshot, compute.snapshots.create.

Base Command#

gcp-compute-disk-snapshot-create

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the persistent disk to snapshot.Required
snapshot_nameThe name of the snapshot to create.Required
descriptionThe optional description of the snapshot.Optional
snapshot_encryption_key_raw_keyThe 256-bit customer-supplied encryption key for the snapshot, encoded in RFC 4648 base64.Optional
snapshot_encryption_key_kms_key_nameThe name of the encryption key for the snapshot that is stored in Google Cloud KMS.Optional
source_disk_encryption_key_raw_keyThe 256-bit customer-supplied encryption key of the source disk, encoded in RFC 4648 base64.Optional
source_disk_encryption_key_kms_key_nameThe name of the encryption key of the source disk that is stored in Google Cloud KMS.Optional
labelsThe labels to apply to this snapshot, in the format key=abc,value=123;key=def,value=456.Optional
label_fingerprintThe fingerprint of the labels being applied to this snapshot, used for optimistic locking. An up-to-date fingerprint hash must always be provided, otherwise the request fails with error 412 conditionNotMet.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation.
GCP.Compute.Operations.nameStringThe name of the operation resource.
GCP.Compute.Operations.kindStringThe type of the resource, for example compute#operation.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.statusStringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.progressNumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For a create snapshot operation, this points to the persistent disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the operation resource.
GCP.Compute.Operations.insertTimeDateThe time that this operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeDateThe time that this operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeDateThe time that this operation was completed, in RFC3339 text format.
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors list with the code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warnings generated during processing of the operation, each containing the code, message, and data fields.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, which is set when the operation is created.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example 404 when the resource was not found.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulk request.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example user@example.com.

gcp-compute-disk-types-list#


Retrieves a list of disk types available in the specified zone. Required permission: compute.diskTypes.list.

Base Command#

gcp-compute-disk-types-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
next_tokenThe token for pagination. Set it to the value of GCP.Compute.DiskTypesNextToken returned by a previous request to get the next page of results.Optional
filterThe filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a disk type named pd-standard, use name != pd-standard.Optional
order_byThe order in which to sort the list results. By default, results are returned in alphanumerical order based on the resource name. Results can also be sorted in descending order based on the creation timestamp using creationTimestamp desc.Optional

Context Output#

PathTypeDescription
GCP.Compute.DiskTypes.idStringThe unique identifier for the disk type resource.
GCP.Compute.DiskTypes.nameStringThe name of the disk type resource.
GCP.Compute.DiskTypes.kindStringThe type of the resource, for example compute#diskType.
GCP.Compute.DiskTypes.descriptionStringThe optional description of the disk type.
GCP.Compute.DiskTypes.validDiskSizeStringThe optional textual description of the valid disk size, such as 10GB-10TB.
GCP.Compute.DiskTypes.defaultDiskSizeGbStringThe server-defined default disk size in GB.
GCP.Compute.DiskTypes.zoneStringThe URL of the zone where the disk type resides.
GCP.Compute.DiskTypes.regionStringThe URL of the region where the disk type resides. Only applicable for regional resources.
GCP.Compute.DiskTypes.creationTimestampDateThe creation timestamp of the disk type in RFC3339 text format.
GCP.Compute.DiskTypes.selfLinkStringThe server-defined URL for the disk type resource.
GCP.Compute.DiskTypes.deprecatedUnknownThe deprecation status associated with this disk type, containing the state, replacement, deprecated, obsolete, and deleted fields.
GCP.Compute.DiskTypesNextTokenStringThe token for the next page of results, used for pagination.
GCP.Compute.DiskTypesWarningUnknownThe informational warning returned by the API, containing the code, message, and data fields. For example, NO_RESULTS_ON_PAGE when the page holds no results.

gcp-compute-disk-types-aggregated-list#


Retrieves an aggregated list of disk types across all zones in the project. Required permission: compute.diskTypes.list.

Base Command#

gcp-compute-disk-types-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return, ranging from 1 to 500. Default is 50.Optional
next_tokenThe token for pagination. Set it to the value of GCP.Compute.AggregatedDiskTypesNextToken returned by a previous request to get the next page of results.Optional
filterThe filter expression for resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value, which can be a string, number, or boolean. For example, to exclude a disk type named pd-standard, use name != pd-standard.Optional
order_byThe order in which to sort the list results. By default, results are returned in alphanumerical order based on the resource name. Results can also be sorted in descending order based on the creation timestamp using creationTimestamp desc.Optional

Context Output#

PathTypeDescription
GCP.Compute.DiskTypes.idStringThe unique identifier for the disk type resource.
GCP.Compute.DiskTypes.nameStringThe name of the disk type resource.
GCP.Compute.DiskTypes.kindStringThe type of the resource, for example compute#diskType.
GCP.Compute.DiskTypes.descriptionStringThe optional description of the disk type.
GCP.Compute.DiskTypes.validDiskSizeStringThe optional textual description of the valid disk size, such as 10GB-10TB.
GCP.Compute.DiskTypes.defaultDiskSizeGbStringThe server-defined default disk size in GB.
GCP.Compute.DiskTypes.zoneStringThe URL of the zone where the disk type resides.
GCP.Compute.DiskTypes.regionStringThe URL of the region where the disk type resides. Only applicable for regional resources.
GCP.Compute.DiskTypes.creationTimestampDateThe creation timestamp of the disk type in RFC3339 text format.
GCP.Compute.DiskTypes.selfLinkStringThe server-defined URL for the disk type resource.
GCP.Compute.DiskTypes.deprecatedUnknownThe deprecation status associated with this disk type, containing the state, replacement, deprecated, obsolete, and deleted fields.
GCP.Compute.AggregatedDiskTypesNextTokenStringThe token for the next page of results, used for pagination.
GCP.Compute.AggregatedDiskTypesWarningUnknownThe informational warning returned by the API, containing the code, message, and data fields. For example, NO_RESULTS_ON_PAGE when the page holds no results.

gcp-compute-disk-type-get#


Returns the specified disk type. Required permission: compute.diskTypes.get.

Base Command#

gcp-compute-disk-type-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
resource_nameThe name of the disk type to return.Required

Context Output#

PathTypeDescription
GCP.Compute.DiskTypes.idStringThe unique identifier for the disk type resource.
GCP.Compute.DiskTypes.nameStringThe name of the disk type resource.
GCP.Compute.DiskTypes.kindStringThe type of the resource, for example compute#diskType.
GCP.Compute.DiskTypes.descriptionStringThe optional description of the disk type.
GCP.Compute.DiskTypes.validDiskSizeStringThe optional textual description of the valid disk size, such as 10GB-10TB.
GCP.Compute.DiskTypes.defaultDiskSizeGbStringThe server-defined default disk size in GB.
GCP.Compute.DiskTypes.zoneStringThe URL of the zone where the disk type resides.
GCP.Compute.DiskTypes.regionStringThe URL of the region where the disk type resides. Only applicable for regional resources.
GCP.Compute.DiskTypes.creationTimestampDateThe creation timestamp of the disk type in RFC3339 text format.
GCP.Compute.DiskTypes.selfLinkStringThe server-defined URL for the disk type resource.
GCP.Compute.DiskTypes.deprecatedUnknownThe deprecation status associated with this disk type, containing the state, replacement, deprecated, obsolete, and deleted fields.

gcp-compute-machine-types-aggregated-list#


Retrieves an aggregated list of machine types across all zones of the specified project. Required permission: compute.machineTypes.list.

Base Command#

gcp-compute-machine-types-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results per page to return, ranging from 1 to 500. If the number of available results is larger than the limit, a token is returned in the nextPageToken field to retrieve the next page of results in subsequent list requests. Default is 50.Optional
filterThe filter expression to use for filtering resources listed in the response. Must specify the field name, a comparison operator, and the filtering value. The value can be a string, a number, or a boolean. The comparison operator must be "=", "!=", ">", or "<". For example, to exclude a region named "example-region", specify name != example-region.Optional
order_byThe order in which to sort the list results. Can be "alphanumerical" (default, based on resource name) or "creationTimestamp desc" (reverse chronological order, latest first).Optional
next_tokenThe page token to use. Set next_token to the value of GCP.Compute.AggregatedMachineTypesNextToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.MachineTypes.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.MachineTypes.creationTimestampstringThe creation timestamp in RFC3339 text format (e.g., 2024-01-15T12:34:56Z).
GCP.Compute.MachineTypes.namestringThe name of the resource.
GCP.Compute.MachineTypes.descriptionstringThe optional textual description of the resource.
GCP.Compute.MachineTypes.guestCpusnumberThe number of virtual CPUs that are available to the instance.
GCP.Compute.MachineTypes.memoryMbnumberThe amount of physical memory available to the instance, defined in MB.
GCP.Compute.MachineTypes.acceleratorsUnknownThe list of accelerator configurations assigned to this machine type, containing the guestAcceleratorCount and guestAcceleratorType fields.
GCP.Compute.MachineTypes.scratchDisksUnknownThe list of extended scratch disks assigned to the instance, containing the diskGb field.
GCP.Compute.MachineTypes.maximumPersistentDisksnumberThe maximum persistent disks allowed.
GCP.Compute.MachineTypes.maximumPersistentDisksSizeGbstringThe maximum total persistent disks size (GB) allowed.
GCP.Compute.MachineTypes.deprecatedUnknownThe deprecation status associated with this machine type, containing the state, replacement, deprecated, obsolete, and deleted fields.
GCP.Compute.MachineTypes.zonestringThe name of the zone where the machine type resides, such as us-central1-a.
GCP.Compute.MachineTypes.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.MachineTypes.isSharedCpubooleanWhether this machine type has a shared CPU. See Shared-core machine types for more information.
GCP.Compute.MachineTypes.kindstringThe type of the resource. Always compute#machineType for machine types.
GCP.Compute.AggregatedMachineTypesNextTokenstringThe token to use when requesting the next set of aggregated machine types.

gcp-compute-machine-types-list#


Retrieves a list of machine types available in the specified zone. Required permission: compute.machineTypes.list.

Base Command#

gcp-compute-machine-types-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
limitThe maximum number of results per page to return, ranging from 1 to 500. If the number of available results is larger than the limit, a token is returned in the nextPageToken field to retrieve the next page of results in subsequent list requests. Default is 50.Optional
filterThe filter expression to use for filtering resources listed in the response. Must specify the field name, a comparison operator, and the filtering value. The value can be a string, a number, or a boolean. The comparison operator must be "=", "!=", ">", or "<". For example, to exclude a region named "example-region", specify name != example-region.Optional
order_byThe order in which to sort the list results. Can be "alphanumerical" (default, based on resource name) or "creationTimestamp desc" (reverse chronological order, latest first).Optional
next_tokenThe page token to use. Set next_token to the value of GCP.Compute.MachineTypesNextToken returned by a previous list request to get the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.MachineTypes.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.MachineTypes.creationTimestampstringThe creation timestamp in RFC3339 text format (e.g., 2024-01-15T12:34:56Z).
GCP.Compute.MachineTypes.namestringThe name of the resource.
GCP.Compute.MachineTypes.descriptionstringThe optional textual description of the resource.
GCP.Compute.MachineTypes.guestCpusnumberThe number of virtual CPUs that are available to the instance.
GCP.Compute.MachineTypes.memoryMbnumberThe amount of physical memory available to the instance, defined in MB.
GCP.Compute.MachineTypes.acceleratorsUnknownThe list of accelerator configurations assigned to this machine type, containing the guestAcceleratorCount and guestAcceleratorType fields.
GCP.Compute.MachineTypes.scratchDisksUnknownThe list of extended scratch disks assigned to the instance, containing the diskGb field.
GCP.Compute.MachineTypes.maximumPersistentDisksnumberThe maximum persistent disks allowed.
GCP.Compute.MachineTypes.maximumPersistentDisksSizeGbstringThe maximum total persistent disks size (GB) allowed.
GCP.Compute.MachineTypes.deprecatedUnknownThe deprecation status associated with this machine type, containing the state, replacement, deprecated, obsolete, and deleted fields.
GCP.Compute.MachineTypes.zonestringThe name of the zone where the machine type resides, such as us-central1-a.
GCP.Compute.MachineTypes.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.MachineTypes.isSharedCpubooleanWhether this machine type has a shared CPU. See Shared-core machine types for more information.
GCP.Compute.MachineTypes.kindstringThe type of the resource. Always compute#machineType for machine types.
GCP.Compute.MachineTypesNextTokenstringThe token to use when requesting the next set of machine types.

gcp-compute-machine-type-get#


Returns the specified machine type. Required permission: compute.machineTypes.get.

Base Command#

gcp-compute-machine-type-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
machine_typeThe name of the machine type to return.Required

Context Output#

PathTypeDescription
GCP.Compute.MachineTypes.idstringThe unique identifier for the resource. This identifier is defined by the server.
GCP.Compute.MachineTypes.creationTimestampstringThe creation timestamp in RFC3339 text format (e.g., 2024-01-15T12:34:56Z).
GCP.Compute.MachineTypes.namestringThe name of the resource.
GCP.Compute.MachineTypes.descriptionstringThe optional textual description of the resource.
GCP.Compute.MachineTypes.guestCpusnumberThe number of virtual CPUs that are available to the instance.
GCP.Compute.MachineTypes.memoryMbnumberThe amount of physical memory available to the instance, defined in MB.
GCP.Compute.MachineTypes.acceleratorsUnknownThe list of accelerator configurations assigned to this machine type, containing the guestAcceleratorCount and guestAcceleratorType fields.
GCP.Compute.MachineTypes.scratchDisksUnknownThe list of extended scratch disks assigned to the instance, containing the diskGb field.
GCP.Compute.MachineTypes.maximumPersistentDisksnumberThe maximum persistent disks allowed.
GCP.Compute.MachineTypes.maximumPersistentDisksSizeGbstringThe maximum total persistent disks size (GB) allowed.
GCP.Compute.MachineTypes.deprecatedUnknownThe deprecation status associated with this machine type, containing the state, replacement, deprecated, obsolete, and deleted fields.
GCP.Compute.MachineTypes.zonestringThe name of the zone where the machine type resides, such as us-central1-a.
GCP.Compute.MachineTypes.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.MachineTypes.isSharedCpubooleanWhether this machine type has a shared CPU. See Shared-core machine types for more information.
GCP.Compute.MachineTypes.kindstringThe type of the resource. Always compute#machineType for machine types.

gcp-compute-region-operation-delete#


Deletes the specified region-specific Operations resource. Required permission: compute.regionOperations.delete.

Base Command#

gcp-compute-region-operation-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
operationThe name of the Operations resource to delete.Required

Context Output#

There is no context output for this command.

gcp-compute-global-operation-delete#


Deletes the specified global Operations resource. Required permission: compute.globalOperations.delete.

Base Command#

gcp-compute-global-operation-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
operationThe name of the Operations resource to delete.Required

Context Output#

There is no context output for this command.

gcp-compute-zone-operation-get#


Retrieves the specified zone-specific Operations resource. Required permission: compute.zoneOperations.get.

Base Command#

gcp-compute-zone-operation-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
operationThe name of the Operations resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides. Only applicable when performing per-zone operations.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-global-operation-list#


Lists the global Operations resources in the specified project. Required permission: compute.globalOperations.list.

Base Command#

gcp-compute-global-operation-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return. Possible values are 1 to 500. Default is 50.Optional
next_tokenThe token for the next set of results to return, used for pagination. Use the value of GCP.Compute.GlobalOperationsNextToken from the previous response.Optional
filterThe filter expression that filters resources listed in the response. The expression must specify a field name, a comparison operator, and a value (for example, "status = DONE").Optional
order_byThe order to sort list results by. By default, results are returned in alphanumerical order based on the resource name (for example, "creationTimestamp desc").Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.
GCP.Compute.GlobalOperationsNextTokenStringThe token to use as the next_token argument to retrieve the next page of results.

gcp-compute-region-operation-list#


Lists the region-specific Operations resources in the specified project and region. Required permission: compute.regionOperations.list.

Base Command#

gcp-compute-region-operation-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
limitThe maximum number of results to return. Possible values are 1 to 500. Default is 50.Optional
next_tokenThe token for the next set of results to return, used for pagination. Use the value of GCP.Compute.RegionOperationsNextToken from the previous response.Optional
filterThe filter expression that filters resources listed in the response. The expression must specify a field name, a comparison operator, and a value (for example, "status = DONE").Optional
order_byThe order to sort list results by. By default, results are returned in alphanumerical order based on the resource name (for example, "creationTimestamp desc").Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.
GCP.Compute.RegionOperationsNextTokenStringThe token to use as the next_token argument to retrieve the next page of results.

gcp-compute-zone-operation-delete#


Deletes the specified zone-specific Operations resource. Required permission: compute.zoneOperations.delete.

Base Command#

gcp-compute-zone-operation-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
operationThe name of the Operations resource to delete.Required

Context Output#

There is no context output for this command.

gcp-compute-zone-operation-list#


Lists the zone-specific Operations resources in the specified project and zone. Required permission: compute.zoneOperations.list.

Base Command#

gcp-compute-zone-operation-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone for this request.Required
limitThe maximum number of results to return. Possible values are 1 to 500. Default is 50.Optional
next_tokenThe token for the next set of results to return, used for pagination. Use the value of GCP.Compute.ZoneOperationsNextToken from the previous response.Optional
filterThe filter expression that filters resources listed in the response. The expression must specify a field name, a comparison operator, and a value (for example, "status = DONE").Optional
order_byThe order to sort list results by. By default, results are returned in alphanumerical order based on the resource name (for example, "creationTimestamp desc").Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.zoneStringThe URL of the zone where the operation resides. Only applicable when performing per-zone operations.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.
GCP.Compute.ZoneOperationsNextTokenStringThe token to use as the next_token argument to retrieve the next page of results.

gcp-compute-global-operation-get#


Retrieves the specified global Operations resource. Required permission: compute.globalOperations.get.

Base Command#

gcp-compute-global-operation-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
operationThe name of the Operations resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-region-operation-get#


Retrieves the specified region-specific Operations resource. Required permission: compute.regionOperations.get.

Base Command#

gcp-compute-region-operation-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe name of the region for this request.Required
operationThe name of the Operations resource to return.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idStringThe unique identifier for the operation, defined by the server.
GCP.Compute.Operations.nameStringThe name of the operation.
GCP.Compute.Operations.regionStringThe URL of the region where the operation resides. Only applicable when performing regional operations.
GCP.Compute.Operations.clientOperationIdStringThe value of the request ID if one was provided in the request. Not present otherwise.
GCP.Compute.Operations.operationTypeStringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkStringThe URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
GCP.Compute.Operations.targetIdStringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusStringThe status of the operation. Possible values are PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessageStringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userStringThe user who requested the operation, for example, "user@example.com".
GCP.Compute.Operations.progressNumberThe optional progress indicator, ranging from 0 to 100. This number monotonically increases as the operation progresses.
GCP.Compute.Operations.insertTimeStringThe time the operation was requested, in RFC3339 text format.
GCP.Compute.Operations.startTimeStringThe time the operation was started by the server, in RFC3339 text format.
GCP.Compute.Operations.endTimeStringThe time the operation was completed, in RFC3339 text format.
GCP.Compute.Operations.error.errorsUnknownThe array of errors encountered while processing the operation, including the error type identifier, the field in the request that caused the error, the optional human-readable error message, and the optional list of messages that contain the error details.
GCP.Compute.Operations.warnings.codeStringThe warning code, if applicable. For example, NO_RESULTS_ON_PAGE is returned when there are no results in the response.
GCP.Compute.Operations.warnings.messageStringThe human-readable description of the warning code.
GCP.Compute.Operations.warnings.dataUnknownThe metadata about this warning, in key: value format, where the key provides more detail on the warning being returned and the value is the corresponding warning data value.
GCP.Compute.Operations.httpErrorStatusCodeNumberThe HTTP error status code that was returned if the operation failed, for example, 404 when the resource was not found.
GCP.Compute.Operations.httpErrorMessageStringThe HTTP error message that was returned if the operation failed, such as NOT FOUND.
GCP.Compute.Operations.selfLinkStringThe server-defined URL for the resource.
GCP.Compute.Operations.descriptionStringThe textual description of the operation, set when the operation is created.
GCP.Compute.Operations.operationGroupIdStringThe ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
GCP.Compute.Operations.setCommonInstanceMetadataOperationMetadataUnknownThe information on all underlying zonal actions and their state. Populated when the operation is for projects.setCommonInstanceMetadata.
GCP.Compute.Operations.instancesBulkInsertOperationMetadataUnknownThe per-location status of the operation. Populated when the operation is for a bulk insert of instances.
GCP.Compute.Operations.getVersionOperationMetadataUnknownThe inline SBOM information for the operation, containing the current and target component versions.
GCP.Compute.Operations.kindStringThe type of the resource. Always compute#operation for Operation resources.

gcp-compute-instance-group-instances-list#


Lists the instances in the specified instance group. Required permission: compute.instanceGroups.list.

Base Command#

gcp-compute-instance-group-instances-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required
instance_groupThe name of the instance group from which to generate the list of included instances.Required
instance_stateThe filter for the state of the instances in the instance group. If not specified, the list includes all instances regardless of their state. Possible values are: ALL, RUNNING.Optional
limitThe maximum number of results per page that should be returned. If the number of available results is larger than limit, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
filterThe expression to filter resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value (string, number, or boolean). For example, to exclude an instance group named example-group, specify name != example-group.Optional
order_byThe sort order for the results. By default, results are returned in alphanumerical order by resource name. To sort in descending order by creation timestamp, use order_by=creationTimestamp desc.Optional
next_tokenThe page token to use. Set next_token to the nextPageToken returned by a previous list request to retrieve the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.InstanceGroups.idstringThe name of the instance group whose instances were listed.
GCP.Compute.InstanceGroups.Instances.instancestringThe URL of the instance.
GCP.Compute.InstanceGroups.Instances.statusstringThe status of the instance.
GCP.Compute.InstanceGroups.Instances.namedPortsUnknownThe named ports assigned to the instance. Each named port contains: name - the name of the named port, which must be 1 to 63 characters long and comply with RFC1035; port - the port number, which can be a value between 1 and 65535.
GCP.Compute.InstanceGroups.InstanceGroupsInstancesNextTokenstringThe token to use to retrieve the next page of instance group instances results.

gcp-compute-instance-group-insert#


Creates an instance group in the specified project and zone. Required permission: compute.instanceGroups.create.

Base Command#

gcp-compute-instance-group-insert

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is created.Required
nameThe name of the instance group. The name must be 1 to 63 characters long and comply with RFC1035.Required
descriptionThe optional description of this resource.Optional
named_portsThe named ports to assign to the instance group. For example: name=http,port=80;name=https,port=443.Optional
networkThe URL of the network to which all instances in the instance group belong.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe date and time that this operation was requested in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe date and time that this operation was started by the server, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe date and time that this operation was completed, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors array with code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, containing code, message, and data fields.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.kindstringThe type of the resource. The value is always compute#operation for Operation resources.

gcp-compute-instance-groups-aggregated-list#


Retrieves the list of instance groups in the specified project across all zones. Required permission: compute.instanceGroups.list.

Base Command#

gcp-compute-instance-groups-aggregated-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results per page that should be returned. If the number of available results is larger than limit, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
filterThe expression to filter resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value (string, number, or boolean). For example, to exclude an instance group named example-group, specify name != example-group.Optional
order_byThe sort order for the results. By default, results are returned in alphanumerical order by resource name. To sort in descending order by creation timestamp, use order_by=creationTimestamp desc.Optional
next_tokenThe page token to use. Set next_token to the nextPageToken returned by a previous list request to retrieve the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.InstanceGroups.idstringThe unique identifier for the server-defined resource.
GCP.Compute.InstanceGroups.creationTimestampstringThe creation timestamp for this instance group in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.InstanceGroups.namestringThe name of the instance group. The name must be 1 to 63 characters long and comply with RFC1035.
GCP.Compute.InstanceGroups.descriptionstringThe optional description of this resource.
GCP.Compute.InstanceGroups.namedPorts.namestringThe name of the named port. The name must be 1 to 63 characters long and comply with RFC1035.
GCP.Compute.InstanceGroups.namedPorts.portnumberThe port number, which can be a value between 1 and 65535.
GCP.Compute.InstanceGroups.networkstringThe URL of the network to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.fingerprintstringThe fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
GCP.Compute.InstanceGroups.zonestringThe URL of the zone where the instance group is located (for zonal resources).
GCP.Compute.InstanceGroups.selfLinkstringThe server-generated URL for this instance group.
GCP.Compute.InstanceGroups.sizenumberThe total number of instances in the instance group.
GCP.Compute.InstanceGroups.regionstringThe URL of the region where the instance group is located (for regional resources).
GCP.Compute.InstanceGroups.subnetworkstringThe URL of the subnetwork to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.kindstringThe resource type, which is always compute#instanceGroup for instance groups.
GCP.Compute.AggregatedInstanceGroupsNextTokenstringThe token to use to retrieve the next page of aggregated instance group results.
GCP.Compute.AggregatedInstanceGroupsSelfLinkstringThe server-defined URL for the aggregated instance groups list request.
GCP.Compute.AggregatedInstanceGroupsWarningUnknownThe informational warning which replaces the list of instance groups when the list is empty.

gcp-compute-instance-groups-list#


Retrieves the list of instance groups that are located in the specified project and zone. Required permission: compute.instanceGroups.list.

Base Command#

gcp-compute-instance-groups-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance groups are located.Required
limitThe maximum number of results per page that should be returned. If the number of available results is larger than limit, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
filterThe expression to filter resources listed in the response. The expression must specify a field name, a comparison operator (=, !=, >, or <), and a value (string, number, or boolean). For example, to exclude an instance group named example-group, specify name != example-group.Optional
order_byThe sort order for the results. By default, results are returned in alphanumerical order by resource name. To sort in descending order by creation timestamp, use order_by=creationTimestamp desc.Optional
next_tokenThe page token to use. Set next_token to the nextPageToken returned by a previous list request to retrieve the next page of results.Optional

Context Output#

PathTypeDescription
GCP.Compute.InstanceGroups.idstringThe unique identifier for the server-defined resource.
GCP.Compute.InstanceGroups.creationTimestampstringThe creation timestamp for this instance group in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.InstanceGroups.namestringThe name of the instance group. The name must be 1 to 63 characters long and comply with RFC1035.
GCP.Compute.InstanceGroups.descriptionstringThe optional description of this resource.
GCP.Compute.InstanceGroups.namedPorts.namestringThe name of the named port. The name must be 1 to 63 characters long and comply with RFC1035.
GCP.Compute.InstanceGroups.namedPorts.portnumberThe port number, which can be a value between 1 and 65535.
GCP.Compute.InstanceGroups.networkstringThe URL of the network to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.fingerprintstringThe fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
GCP.Compute.InstanceGroups.zonestringThe URL of the zone where the instance group is located (for zonal resources).
GCP.Compute.InstanceGroups.selfLinkstringThe server-generated URL for this instance group.
GCP.Compute.InstanceGroups.sizenumberThe total number of instances in the instance group.
GCP.Compute.InstanceGroups.regionstringThe URL of the region where the instance group is located (for regional resources).
GCP.Compute.InstanceGroups.subnetworkstringThe URL of the subnetwork to which all instances in the instance group belong.
GCP.Compute.InstanceGroups.kindstringThe resource type, which is always compute#instanceGroup for instance groups.
GCP.Compute.InstanceGroupsNextTokenstringThe token to use to retrieve the next page of instance group results.
GCP.Compute.InstanceGroupsSelfLinkstringThe server-defined URL for the instance groups list request.
GCP.Compute.InstanceGroupsWarningUnknownThe informational warning which replaces the list of instance groups when the list is empty.

gcp-compute-instance-group-named-ports-set#


Sets the named ports for the specified instance group. Required permission: compute.instanceGroups.update.

Base Command#

gcp-compute-instance-group-named-ports-set

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required
instance_groupThe name of the instance group where the named ports are updated.Required
named_portsThe list of named ports to set for this instance group. For example: name=http,port=80;name=https,port=443.Required
fingerprintThe fingerprint of the named ports information for this instance group. Use this optional argument to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the gcp-compute-instance-group-get command. A request with an incorrect fingerprint fails with error 412 conditionNotMet.Optional

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe date and time that this operation was requested, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe date and time that this operation was started by the server, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe date and time that this operation was completed, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors array with code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, containing code, message, and data fields.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.kindstringThe type of the resource. The value is always compute#operation for Operation resources.

gcp-compute-instance-group-instances-add#


Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network or subnetwork. Required permission: compute.instanceGroups.update.

Base Command#

gcp-compute-instance-group-instances-add

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required
instance_groupThe name of the instance group where the instances are added.Required
instancesA comma-separated list of URLs of the instances to add to the instance group.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe date and time that this operation was requested, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe date and time that this operation was started by the server, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe date and time that this operation was completed, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors array with code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, containing code, message, and data fields.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.kindstringThe type of the resource. The value is always compute#operation for Operation resources.

gcp-compute-instance-group-delete#


Deletes the specified instance group. The instances in the group are not deleted. The instance group must not belong to a back-end service. Required permission: compute.instanceGroups.delete.

Base Command#

gcp-compute-instance-group-delete

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required
instance_groupThe name of the instance group to delete.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe date and time that this operation was requested, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe date and time that this operation was started by the server, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe date and time that this operation was completed, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors array with code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, containing code, message, and data fields.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.kindstringThe type of the resource. The value is always compute#operation for Operation resources.

gcp-compute-instance-group-instances-remove#


Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a back-end service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration for the VM instance to be removed or deleted. Required permission: compute.instanceGroups.update.

Base Command#

gcp-compute-instance-group-instances-remove

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
zoneThe name of the zone where the instance group is located.Required
instance_groupThe name of the instance group from which the instances are removed.Required
instancesA comma-separated list of URLs of the instances to remove from the instance group.Required

Context Output#

PathTypeDescription
GCP.Compute.Operations.idstringThe unique identifier for the server-defined resource.
GCP.Compute.Operations.namestringThe name of the resource.
GCP.Compute.Operations.zonestringThe URL of the zone where the operation resides.
GCP.Compute.Operations.operationTypestringThe type of operation, such as insert, update, or delete.
GCP.Compute.Operations.targetLinkstringThe URL of the resource that the operation modifies.
GCP.Compute.Operations.targetIdstringThe unique target ID, which identifies a specific incarnation of the target resource.
GCP.Compute.Operations.statusstringThe status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
GCP.Compute.Operations.statusMessagestringThe optional textual description of the current status of the operation.
GCP.Compute.Operations.userstringThe user who requested the operation.
GCP.Compute.Operations.progressnumberThe optional progress indicator that ranges from 0 to 100.
GCP.Compute.Operations.insertTimestringThe date and time that this operation was requested, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.startTimestringThe date and time that this operation was started by the server, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.endTimestringThe date and time that this operation was completed, in RFC3339 format (for example, 2024-01-15T12:34:56Z).
GCP.Compute.Operations.errorUnknownThe errors generated during processing of the operation, containing an errors array with code, location, and message fields.
GCP.Compute.Operations.warningsUnknownThe warning messages generated during processing of the operation, containing code, message, and data fields.
GCP.Compute.Operations.httpErrorStatusCodenumberThe HTTP error status code that is returned if the operation fails.
GCP.Compute.Operations.httpErrorMessagestringThe HTTP error message that is returned if the operation fails, such as NOT FOUND.
GCP.Compute.Operations.selfLinkstringThe server-defined URL for the resource.
GCP.Compute.Operations.kindstringThe type of the resource. The value is always compute#operation for Operation resources.

gcp-logging-log-entries-list#


Lists log entries. Use this command to retrieve log entries that originated from a project, organization, billing account, or folder. Required Permissions: logging.logEntries.list.

Base Command#

gcp-logging-log-entries-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID to read log entries from. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
organization_namesA comma-separated list of organization IDs of parent resources from which to retrieve log entries. A maximum of 100 resources may be specified.Optional
billing_account_namesA comma-separated list of billing account IDs of parent resources from which to retrieve log entries. A maximum of 100 resources may be specified.Optional
folder_namesA comma-separated list of folder IDs of parent resources from which to retrieve log entries. A maximum of 100 resources may be specified.Optional
filterThe filter to limit results to log entries that match. The maximum length of a filter is 20,000 characters. For example: "protoPayload.requestMetadata.callerIp:1.1.1.1 AND protoPayload.serviceName:name".Optional
order_byThe criteria to use for sorting the results. Can be "timestamp asc" or "timestamp desc". Possible values are: timestamp asc, timestamp desc. Default is timestamp asc.Optional
limitThe maximum number of results to return. Valid range is 1-500. Default is 50.Optional
next_tokenThe token used to retrieve the next batch of results. Must be the value of LogEntriesNextToken from the previous response.Optional

Context Output#

PathTypeDescription
GCP.Logging.LogEntries.logNameStringThe resource name of the log to which this log entry belongs.
GCP.Logging.LogEntries.resource.typeStringThe monitored resource type.
GCP.Logging.LogEntries.resource.labelsUnknownThe values for all labels listed in the associated monitored resource descriptor.
GCP.Logging.LogEntries.timestampStringThe time the event described by the log entry occurred, in RFC 3339 UTC "Zulu" format. For example: "2014-10-02T15:01:23Z".
GCP.Logging.LogEntries.receiveTimestampStringThe time the log entry was received by Logging, in RFC 3339 UTC "Zulu" format. For example: "2014-10-02T15:01:23Z".
GCP.Logging.LogEntries.severityStringThe severity of the log entry. The default value is LogSeverity.DEFAULT.
GCP.Logging.LogEntries.insertIdStringA unique identifier for the log entry.
GCP.Logging.LogEntries.httpRequestUnknownThe HTTP request associated with the log entry, containing requestMethod, requestUrl, status, userAgent, remoteIp, and other fields.
GCP.Logging.LogEntries.labelsUnknownThe map of key-value pairs that provides additional information about the log entry.
GCP.Logging.LogEntries.operationUnknownThe information about an operation associated with the log entry, containing the ID, producer, first, and last fields.
GCP.Logging.LogEntries.traceStringThe REST resource name of the trace being written to Cloud Trace in association with this log entry.
GCP.Logging.LogEntries.spanIdStringThe ID of the Cloud Trace span associated with the current operation in which the log is being written.
GCP.Logging.LogEntries.traceSampledBooleanThe sampling decision of the trace associated with the log entry.
GCP.Logging.LogEntries.sourceLocationUnknownThe source code location information associated with the log entry, containing file, line, and function fields.
GCP.Logging.LogEntries.splitUnknownThe information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry, containing the UID, index, and totalSplits fields.
GCP.Logging.LogEntries.errorGroupsUnknownThe Error Reporting error groups associated with this LogEntry, if any.
GCP.Logging.LogEntries.apphubUnknownThe AppHub application metadata associated with the monitored resource of this log entry.
GCP.Logging.LogEntries.apphubDestinationUnknownThe AppHub application metadata associated with the destination of this log entry.
GCP.Logging.LogEntries.apphubSourceUnknownThe AppHub application metadata associated with the source of this log entry.
GCP.Logging.LogEntries.protoPayloadUnknownThe log entry payload, represented as a protocol buffer. A log entry has exactly one of protoPayload, textPayload, or jsonPayload.
GCP.Logging.LogEntries.textPayloadStringThe log entry payload, represented as a Unicode string (UTF-8). A log entry has exactly one of protoPayload, textPayload, or jsonPayload.
GCP.Logging.LogEntries.jsonPayloadUnknownThe log entry payload, represented as a structure that is expressed as a JSON object. A log entry has exactly one of protoPayload, textPayload, or jsonPayload.
GCP.Logging.LogEntriesNextTokenStringThe nextPageToken included when there are more results than those appearing in this response. To get the next set of results, call this command again using the value of nextPageToken as next_token.

gcp-cloudrun-functions-list#


Lists Google Cloud Functions in the specified project and region. Required Permission: cloudfunctions.functions.list.

Base Command#

gcp-cloudrun-functions-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe region of the Google Cloud functions. Default is all regions. To get a full list of regions, run the gcp-cloudrun-locations-list command.Optional
limitThe maximum number of results to return. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
next_tokenThe pagination token used to return the next set of items.Optional
filterThe filter expression for the functions listed in the response. For example, to return only active functions, use state="ACTIVE".Optional
order_byA comma-separated list of fields by which to sort the returned functions. Append desc to a field to sort it in descending order. For example, name desc.Optional

Context Output#

PathTypeDescription
GCP.CloudRun.Functions.nameStringThe user-defined name of the function, which must be globally unique and match the pattern projects//locations//functions/*.
GCP.CloudRun.Functions.descriptionStringThe user-provided description of the function.
GCP.CloudRun.Functions.buildConfigUnknownThe build step of the function that builds a container from the given source.
GCP.CloudRun.Functions.serviceConfigUnknownThe fully managed Cloud Run service being deployed.
GCP.CloudRun.Functions.eventTriggerUnknownThe source that fires events in response to a condition in another service.
GCP.CloudRun.Functions.stateStringThe state of the function. Possible values are: STATE_UNSPECIFIED, ACTIVE, FAILED, DEPLOYING, DELETING, UNKNOWN, DETACHING, DETACH_FAILED.
GCP.CloudRun.Functions.updateTimeDateThe last update timestamp of the function. For example: "2014-10-02T15:01:23Z".
GCP.CloudRun.Functions.labelsUnknownThe labels associated with the function.
GCP.CloudRun.Functions.stateMessagesUnknownThe state messages for the function.
GCP.CloudRun.Functions.environmentStringThe generation of the function. Can be "ENVIRONMENT_UNSPECIFIED", "GEN_1", or "GEN_2".
GCP.CloudRun.Functions.upgradeInfoUnknownThe upgrade information for the function.
GCP.CloudRun.Functions.urlStringThe deployed URL of the function.
GCP.CloudRun.Functions.kmsKeyNameStringThe user-managed resource name of a KMS crypto key used to encrypt or decrypt function resources, matching the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
GCP.CloudRun.Functions.createTimeDateThe creation timestamp of the function. Applicable only to 2nd Gen functions. For example: 2014-10-02T15:01:23Z.
GCP.CloudRun.FunctionsNextTokenStringThe token to retrieve the next page of Google Cloud Run functions.

gcp-cloudrun-locations-list#


Lists all available Google Cloud Functions regions in the project. Required permission: cloudfunctions.locations.list.

Base Command#

gcp-cloudrun-locations-list

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
limitThe maximum number of results to return. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
next_tokenThe pagination token used to return the next set of items.Optional

Context Output#

PathTypeDescription
GCP.CloudRun.Locations.nameStringThe resource name for the location, which may vary between implementations. For example: projects/example-project/locations/us-east1.
GCP.CloudRun.Locations.locationIdStringThe canonical ID for this location. For example: us-east1.
GCP.CloudRun.Locations.displayNameStringThe friendly name for the location, typically a nearby city name such as Tokyo.
GCP.CloudRun.Locations.labelsUnknownThe cross-service attributes for the location, such as {"cloud.googleapis.com/region": "us-east1"}.
GCP.CloudRun.Locations.metadataUnknownThe service-specific metadata, such as the available capacity at the given location.
GCP.CloudRun.LocationsNextTokenStringThe token used to retrieve the next page of locations.

gcp-cloudrun-function-get#


Gets the details of a specific Google Cloud function. Required permission: cloudfunctions.functions.get.

Base Command#

gcp-cloudrun-function-get

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe region of the Google Cloud function. To get a full list of regions, run the gcp-cloudrun-locations-list command.Required
function_nameThe name of the function.Required

Context Output#

PathTypeDescription
GCP.CloudRun.Functions.nameStringThe user-defined name of the function, which must be globally unique and match the pattern projects/locations/functions/*.
GCP.CloudRun.Functions.descriptionStringThe user-provided description of the function.
GCP.CloudRun.Functions.buildConfigUnknownThe build step of the function that builds a container from the given source.
GCP.CloudRun.Functions.serviceConfigUnknownThe fully managed Cloud Run service being deployed.
GCP.CloudRun.Functions.eventTriggerUnknownThe source that fires events in response to a condition in another service.
GCP.CloudRun.Functions.stateStringThe state of the function. Possible values are: STATE_UNSPECIFIED, ACTIVE, FAILED, DEPLOYING, DELETING, UNKNOWN, DETACHING, DETACH_FAILED.
GCP.CloudRun.Functions.updateTimeDateThe last update timestamp of the function. For example: "2014-10-02T15:01:23Z".
GCP.CloudRun.Functions.labelsUnknownThe labels associated with the function.
GCP.CloudRun.Functions.stateMessagesUnknownThe state messages for the function.
GCP.CloudRun.Functions.environmentStringThe generation of the function. Can be "ENVIRONMENT_UNSPECIFIED", "GEN_1", or "GEN_2".
GCP.CloudRun.Functions.upgradeInfoUnknownThe upgrade information for the function.
GCP.CloudRun.Functions.urlStringThe deployed URL of the function.
GCP.CloudRun.Functions.kmsKeyNameStringThe user-managed resource name of a KMS crypto key used to encrypt or decrypt function resources, matching the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
GCP.CloudRun.Functions.createTimeDateThe creation timestamp of the function. Applicable only to 2nd Gen functions. For example: 2014-10-02T15:01:23Z.

gcp-cloudfunctions-function-execute#


Synchronously invokes a deployed Google Cloud (1st Gen) function and returns its execution result. Required permission: cloudfunctions.functions.call.

Base Command#

gcp-cloudfunctions-function-execute

Input#

Argument NameDescriptionRequired
project_idThe GCP project ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration.Optional
regionThe region of the Google Cloud function. To get a full list of regions, run the gcp-cloudrun-locations-list command.Required
function_nameThe name of the function to invoke.Required
dataThe input data passed to the function, such as a JSON-encoded string.Optional

Context Output#

PathTypeDescription
GCP.CloudFunctions.Execution.executionIdStringThe execution ID of the function invocation.
GCP.CloudFunctions.Execution.resultStringThe result of the function invocation, returned as a string.
GCP.CloudFunctions.Execution.errorStringThe error message if the function execution resulted in an error.

gcp-resource-manager-project-create#


Creates a new GCP project under the specified parent (organization or folder). Required Permission: resourcemanager.projects.create.

Base Command#

gcp-resource-manager-project-create

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
project_idThe unique, user-assigned ID of the project to create. Must be 6 to 30 lowercase letters, digits, or hyphens, and must start with a letter. Trailing hyphens are prohibited (for example, tokyo-rain-123).Required
parentThe resource name of the parent under which to create the project, in the form "organizations/[organization_id]" or "folders/[folder_id]".Required
display_nameThe user-assigned display name of the project. Must be 4 to 30 characters.Optional
labelsAn object containing a list of "key": value pairs to associate with the project, without spaces. Example: key=abc,value=123;key=ABC,value=321.Optional

Context Output#

PathTypeDescription
GCP.ResourceManager.Operations.nameStringThe server-assigned name of the long-running operation tracking the request (for example, operations/cp.1234567890).
GCP.ResourceManager.Operations.doneBooleanWhether the operation has completed. If false, the operation is still in progress.
GCP.ResourceManager.Operations.metadataObjectService-specific metadata associated with the operation.
GCP.ResourceManager.Operations.responseObjectThe normal response of the operation on success. Present only when the operation has completed.
GCP.ResourceManager.Operations.errorObjectThe error result of the operation in case of failure or cancellation.

gcp-resource-manager-project-get#


Retrieves a GCP project by its project ID. Required Permission: resourcemanager.projects.get.

Base Command#

gcp-resource-manager-project-get

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
project_idThe unique ID of the project to fetch (for example, tokyo-rain-123).Required

Context Output#

PathTypeDescription
GCP.ResourceManager.Projects.nameStringThe resource name of the project (for example, projects/415104041262).
GCP.ResourceManager.Projects.projectIdStringThe unique, user-assigned ID of the project.
GCP.ResourceManager.Projects.displayNameStringThe user-assigned display name of the project.
GCP.ResourceManager.Projects.stateStringThe project lifecycle state.
GCP.ResourceManager.Projects.createTimeStringThe time the project was created, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Projects.parentStringThe resource name of the project's parent.
GCP.ResourceManager.Projects.labelsObjectThe labels associated with the project.
GCP.ResourceManager.Projects.updateTimeStringThe time the project was last modified, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Projects.deleteTimeStringThe time the project was marked for deletion, in ISO 8601 format (for example, "2024-01-15T12:34:56Z"). Present only when the project is in the DELETE_REQUESTED state.
GCP.ResourceManager.Projects.etagStringA checksum computed by the server, used for optimistic concurrency control.
GCP.ResourceManager.Projects.tagsObjectThe tags bound to the project, in the format {tag_key: tag_value}.
GCP.ResourceManager.Projects.configuredCapabilitiesUnknownThe capabilities configured on the project.

gcp-resource-manager-project-search#


Searches for GCP projects that are visible to the caller and match an optional query. Required Permission: resourcemanager.projects.get.

Base Command#

gcp-resource-manager-project-search

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0 , Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
queryThe optional query string to filter the projects. Supported fields include displayName, parent, id, state, and labels.[KEY] (for example, "state:ACTIVE" or "displayName:how*").Optional
limitThe maximum number of results to return. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
next_tokenThe pagination token returned from a previous call, indicating where the listing should continue.Optional

Context Output#

PathTypeDescription
GCP.ResourceManager.Projects.nameStringThe resource name of the project (for example, projects/415104041262).
GCP.ResourceManager.Projects.projectIdStringThe unique, user-assigned ID of the project.
GCP.ResourceManager.Projects.displayNameStringThe user-assigned display name of the project.
GCP.ResourceManager.Projects.stateStringThe project lifecycle state.
GCP.ResourceManager.Projects.createTimeStringThe time the project was created, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Projects.parentStringThe resource name of the project's parent.
GCP.ResourceManager.Projects.labelsObjectThe labels associated with the project.
GCP.ResourceManager.Projects.updateTimeStringThe time the project was last modified, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Projects.deleteTimeStringThe time the project was marked for deletion, in ISO 8601 format (for example, "2024-01-15T12:34:56Z"). Present only when the project is in the DELETE_REQUESTED state.
GCP.ResourceManager.Projects.etagStringA checksum computed by the server, used for optimistic concurrency control.
GCP.ResourceManager.Projects.tagsObjectThe tags bound to the project, in the format {tag_key: tag_value}.
GCP.ResourceManager.Projects.configuredCapabilitiesUnknownThe capabilities configured on the project.
GCP.ResourceManager.ProjectsNextTokenStringThe token to use to retrieve the next batch of projects.

gcp-resource-manager-project-update#


Updates the display name and/or labels of an existing GCP project. Required Permission: resourcemanager.projects.update.

Base Command#

gcp-resource-manager-project-update

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
project_idThe unique ID of the project to update (for example, tokyo-rain-123).Required
display_nameThe new display name for the project. Must be 4 to 30 characters.Optional
labelsAn object containing a list of "key": value pairs to associate with the project, without spaces. Example: key=abc,value=123;key=ABC,value=321.Optional

Context Output#

PathTypeDescription
GCP.ResourceManager.Operations.nameStringThe server-assigned name of the long-running operation tracking the request (for example, operations/cp.1234567890).
GCP.ResourceManager.Operations.doneBooleanWhether the operation has completed. If false, the operation is still in progress.
GCP.ResourceManager.Operations.metadataObjectService-specific metadata associated with the operation.
GCP.ResourceManager.Operations.responseObjectThe normal response of the operation on success. Present only when the operation has completed.
GCP.ResourceManager.Operations.errorObjectThe error result of the operation in case of failure or cancellation.

gcp-resource-manager-project-delete#


Marks a GCP project for deletion (sets its state to DELETE_REQUESTED). Required Permission: resourcemanager.projects.delete.

Base Command#

gcp-resource-manager-project-delete

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
project_idThe unique ID of the project to delete (for example, tokyo-rain-123).Required

Context Output#

PathTypeDescription
GCP.ResourceManager.Operations.nameStringThe server-assigned name of the long-running operation tracking the request (for example, operations/cp.1234567890).
GCP.ResourceManager.Operations.doneBooleanWhether the operation has completed. If false, the operation is still in progress.
GCP.ResourceManager.Operations.metadataObjectService-specific metadata associated with the operation.
GCP.ResourceManager.Operations.responseObjectThe normal response of the operation on success. Present only when the operation has completed.
GCP.ResourceManager.Operations.errorObjectThe error result of the operation in case of failure or cancellation.

gcp-resource-manager-project-undelete#


Restores a GCP project that was previously marked for deletion. Required Permission: resourcemanager.projects.undelete.

Base Command#

gcp-resource-manager-project-undelete

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
project_idThe unique ID of the project to restore (for example, tokyo-rain-123).Required

Context Output#

PathTypeDescription
GCP.ResourceManager.Operations.nameStringThe server-assigned name of the long-running operation tracking the request (for example, operations/cp.1234567890).
GCP.ResourceManager.Operations.doneBooleanWhether the operation has completed. If false, the operation is still in progress.
GCP.ResourceManager.Operations.metadataObjectService-specific metadata associated with the operation.
GCP.ResourceManager.Operations.responseObjectThe normal response of the operation on success. Present only when the operation has completed.
GCP.ResourceManager.Operations.errorObjectThe error result of the operation in case of failure or cancellation.

gcp-resource-manager-organization-search#


Searches for GCP organizations that are visible to the caller and match an optional query. Required Permission: resourcemanager.organizations.get.

Base Command#

gcp-resource-manager-organization-search

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
queryThe optional query string to filter the organizations. Organizations may be filtered by owner.directoryCustomerId or by domain (for example, "domain:google.com").Optional
limitThe maximum number of results to return. Acceptable values are 1 to 500, inclusive. Default is 50.Optional
next_tokenThe pagination token returned from a previous call, indicating where the listing should continue.Optional

Context Output#

PathTypeDescription
GCP.ResourceManager.Organizations.nameStringThe resource name of the organization, in the form "organizations/[organization_id]".
GCP.ResourceManager.Organizations.displayNameStringThe organization's display name.
GCP.ResourceManager.Organizations.stateStringThe organization's current lifecycle state.
GCP.ResourceManager.Organizations.directoryCustomerIdStringThe G Suite / Cloud Identity customer ID used in the Directory API.
GCP.ResourceManager.Organizations.createTimeStringThe time the organization was created, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Organizations.updateTimeStringThe time the organization was last modified, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Organizations.deleteTimeStringThe time the organization was marked for deletion, in ISO 8601 format (for example, "2024-01-15T12:34:56Z"). Present only when the organization is in the DELETE_REQUESTED state.
GCP.ResourceManager.Organizations.etagStringA checksum computed by the server, used for optimistic concurrency control.
GCP.ResourceManager.OrganizationsNextTokenStringThe token to use to retrieve the next batch of organizations.

gcp-resource-manager-organization-get#


Retrieves a GCP organization by its resource name. Required Permission: resourcemanager.organizations.get.

Base Command#

gcp-resource-manager-organization-get

Input#

Argument NameDescriptionRequired
identifierThe GCP resource identifier of the account to authenticate as - a project ID, folder ID, or organization ID. Required for creating the CTS token on Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Used only to obtain credentials, not to filter results. Not required for Cortex XSOAR and Cortex XSIAM versions < 3.0.Optional
nameThe resource name of the organization to fetch, in the form "organizations/[organization_id]" (e.g. organizations/1234).Required

Context Output#

PathTypeDescription
GCP.ResourceManager.Organizations.nameStringThe resource name of the organization, in the form "organizations/[organization_id]".
GCP.ResourceManager.Organizations.displayNameStringThe organization's display name.
GCP.ResourceManager.Organizations.stateStringThe organization's current lifecycle state.
GCP.ResourceManager.Organizations.directoryCustomerIdStringThe G Suite / Cloud Identity customer ID used in the Directory API.
GCP.ResourceManager.Organizations.createTimeStringThe time the organization was created, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Organizations.updateTimeStringThe time the organization was last modified, in ISO 8601 format (for example, "2024-01-15T12:34:56Z").
GCP.ResourceManager.Organizations.deleteTimeStringThe time the organization was marked for deletion, in ISO 8601 format (for example, "2024-01-15T12:34:56Z"). Present only when the organization is in the DELETE_REQUESTED state.
GCP.ResourceManager.Organizations.etagStringA checksum computed by the server, used for optimistic concurrency control.