CP codes

Manage your properties content provider (CP) codes.

Get base IDs

You need your group ID to work with these commands. If you don't have it, run Get-Groups and choose one.

Get CP codes

Get a list of all of your CP codes.

$CPCodes = List-CPCodes

cpcodeId         : 12345
cpcodeName       : My-CP-code
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=Site_Del::Site_Del; productName=Site Delivery}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

cpcodeId         : 56789
cpcodeName       : My-CP-code-2
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=NetStorage::NetStorage; productName=NetStorage}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

The response provides values for your contract, group, and product IDs along with the CP code's name you can use downstream as filters.

Using a returned identifier, get a narrowed down list of CP codes.

# Gets a list of CP codes for the given GroupID
$CPCodes = List-CPCodes -GroupID 12345

cpcodeId         : 12345
cpcodeName       : My-CP-code
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=Site_Del::Site_Del; productName=Site Delivery}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

cpcodeId         : 56789
cpcodeName       : My-CP-code-2
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=NetStorage::NetStorage; productName=NetStorage}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

Substitute the -GroupID parameter with one of the other identifiers to get their respective lists.

To get specific information for one of your CP codes, use its ID as the value for the CP code parameter.

$MyCPCode = Get-CPCode -CPCode 12345

cpcodeId         : 12345
cpcodeName       : My-CP-code
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=Site_Del::Site_Del; productName=Site Delivery}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

Update CP codes

Use the Get and Set commands with the available properties to update your Property Manager CP codes. Paths to CP code properties are in dot notation.

Available properties

Property Description

cpcodeName String. Unique identifier for your CP code.

overrideTimezone

Object. Used for legacy reports. Overrides the time zone assigned to your CP code with the GMT offset. Contains the following properties.

`timezoneId`	String. GMT time zone identifier.
`timezoneValue`	String. The GMT time zone offset.

purgeable Boolean. Purge cached content by the CP code.

Make changes

Pipe to your updated object or use the entire POST body to make your changes.

Make your changes.

# Change the name of a CP code 
Rename-CPCode -CPCode 12345 -NewName My-new-CP-code

cpcodeId         : 12345
cpcodeName       : My-new-CP-code
purgeable        : True
accountId        : A-CCT1234
defaultTimezone  : 
overrideTimezone : @{timezoneId=0; timezoneValue=GMT 0 (Greenwich Mean Time)}
type             : Regular
contracts        : {@{contractId=C-0N7RAC7; status=ongoing}}
products         : {@{productId=Site_Del::Site_Del; productName=Site Delivery}}
accessGroup      : @{groupId=12345; contractId=C-0N7RAC7}

Update the active property configuration with your CP code changes.
```
Set-CPCode -CPCode 12345
```

Activate your property

To apply your changes on the network, you need to version and activate your property configuration.