spokes
Creates, updates, deletes, gets or lists a spokes
resource.
Overview
Name | spokes |
Type | Resource |
Id | google.networkconnectivity.spokes |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id} |
description | string | An optional description of the spoke. |
createTime | string | Output only. The time the spoke was created. |
group | string | Optional. The name of the group that this spoke is associated with. |
hub | string | Immutable. The name of the hub that this spoke is attached to. |
labels | object | Optional labels in key-value pair format. For more information about labels, see Requirements for labels. |
linkedInterconnectAttachments | object | A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. |
linkedRouterApplianceInstances | object | A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. |
linkedVpcNetwork | object | An existing VPC network. |
linkedVpnTunnels | object | A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. |
reasons | array | Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state. |
spokeType | string | Output only. The type of resource associated with the spoke. |
state | string | Output only. The current lifecycle state of this spoke. |
uniqueId | string | Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id . |
updateTime | string | Output only. The time the spoke was last updated. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | locationsId, projectsId, spokesId | Gets details about a Network Connectivity Center spoke. |
list | SELECT | locationsId, projectsId | Lists the Network Connectivity Center spokes in a specified project and location. |
list_spokes | SELECT | hubsId, projectsId | Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted. |
create | INSERT | locationsId, projectsId | Creates a Network Connectivity Center spoke. |
delete | DELETE | locationsId, projectsId, spokesId | Deletes a Network Connectivity Center spoke. |
patch | UPDATE | locationsId, projectsId, spokesId | Updates the parameters of a Network Connectivity Center spoke. |
SELECT
examples
Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.
SELECT
name,
description,
createTime,
group,
hub,
labels,
linkedInterconnectAttachments,
linkedRouterApplianceInstances,
linkedVpcNetwork,
linkedVpnTunnels,
reasons,
spokeType,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.spokes
WHERE hubsId = '{{ hubsId }}'
AND projectsId = '{{ projectsId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new spokes
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.networkconnectivity.spokes (
locationsId,
projectsId,
name,
labels,
description,
hub,
group,
linkedVpnTunnels,
linkedInterconnectAttachments,
linkedRouterApplianceInstances,
linkedVpcNetwork
)
SELECT
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ hub }}',
'{{ group }}',
'{{ linkedVpnTunnels }}',
'{{ linkedInterconnectAttachments }}',
'{{ linkedRouterApplianceInstances }}',
'{{ linkedVpcNetwork }}'
;
- name: your_resource_model_name
props:
- name: name
value: string
- name: createTime
value: string
- name: updateTime
value: string
- name: labels
value: object
- name: description
value: string
- name: hub
value: string
- name: group
value: string
- name: linkedVpnTunnels
value:
- name: uris
value:
- string
- name: siteToSiteDataTransfer
value: boolean
- name: vpcNetwork
value: string
- name: includeImportRanges
value:
- string
- name: linkedInterconnectAttachments
value:
- name: uris
value:
- string
- name: siteToSiteDataTransfer
value: boolean
- name: vpcNetwork
value: string
- name: includeImportRanges
value:
- string
- name: linkedRouterApplianceInstances
value:
- name: instances
value:
- - name: virtualMachine
value: string
- name: ipAddress
value: string
- name: siteToSiteDataTransfer
value: boolean
- name: vpcNetwork
value: string
- name: includeImportRanges
value:
- string
- name: linkedVpcNetwork
value:
- name: uri
value: string
- name: excludeExportRanges
value:
- string
- name: includeExportRanges
value:
- string
- name: producerVpcSpokes
value:
- string
- name: uniqueId
value: string
- name: state
value: string
- name: reasons
value:
- - name: code
value: string
- name: message
value: string
- name: userDetails
value: string
- name: spokeType
value: string
UPDATE
example
Updates a spokes
resource.
/*+ update */
UPDATE google.networkconnectivity.spokes
SET
name = '{{ name }}',
labels = '{{ labels }}',
description = '{{ description }}',
hub = '{{ hub }}',
group = '{{ group }}',
linkedVpnTunnels = '{{ linkedVpnTunnels }}',
linkedInterconnectAttachments = '{{ linkedInterconnectAttachments }}',
linkedRouterApplianceInstances = '{{ linkedRouterApplianceInstances }}',
linkedVpcNetwork = '{{ linkedVpcNetwork }}'
WHERE
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND spokesId = '{{ spokesId }}';
DELETE
example
Deletes the specified spokes
resource.
/*+ delete */
DELETE FROM google.networkconnectivity.spokes
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND spokesId = '{{ spokesId }}';