Logo

Documentation home for Transend tools

Update-GOLocalCache

SYNOPSIS

Refreshes every supported local object cache from a Google Workspace tenant.

SYNTAX

Help

Update-GOLocalCache
  [-ShowPrereqs]
  [<CommonParameters>]

Action

Update-GOLocalCache
  -ConfigNode <String>
  [<CommonParameters>]

DESCRIPTION

Use the Update-GOLocalCache cmdlet to refresh every supported local object cache from a Google Workspace tenant.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Refresh the local cache

Update-GOLocalCache -ConfigNode Source

This example refreshes every supported object cache from a Google Workspace tenant.

PARAMETERS

-ConfigNode

The config.psd1 configuration node to use.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

None

NOTES

Required config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • GOAdmin: The ID of your tenant’s administrator.

  • GOServiceAccountKey: The path to your service account’s JSON key file.

  • GOTenant: The ID of your tenant. For example, source.org.

Optional config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • GOSharedContactsApi: The API to use to retrieve shared contacts. Valid values are People and Contacts.

    Default: People

Required APIs

  • Admin SDK
  • Cloud Identity
  • Cloud Resource Manager
  • Contacts
  • Google Chat
  • Google Drive
  • People

Required scopes

  • https://www.googleapis.com/auth/admin.directory.customer.readonly
  • https://www.googleapis.com/auth/admin.directory.domain.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly
  • https://www.googleapis.com/auth/admin.directory.orgunit.readonly
  • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloudplatformprojects.readonly
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/drive.readonly

General configuration options