LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13829327708

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-13 07:32:22 +00:00
parent fc5edad15a
commit f4180398b2
10 changed files with 397 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgrade.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-cluster-manual-upgrade
title: ClusterManualUpgrade
pagination_label: ClusterManualUpgrade
sidebar_label: ClusterManualUpgrade
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade']
---
# ClusterManualUpgrade
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Jobs** | [**[]ClusterManualUpgradeJobsInner**](cluster-manual-upgrade-jobs-inner) | List of job objects for the upgrade request. | [optional]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgrade = Initialize-PSSailpoint.V2024ClusterManualUpgrade -Jobs null
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgrade | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInner.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner
title: ClusterManualUpgradeJobsInner
pagination_label: ClusterManualUpgradeJobsInner
sidebar_label: ClusterManualUpgradeJobsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner']
---
# ClusterManualUpgradeJobsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **String** | Unique identifier for the upgrade job. | [required]
**Cookbook** | **String** | Identifier for the cookbook used in the upgrade job. | [required]
**State** | **String** | Current state of the upgrade job. | [required]
**Type** | **String** | The type of upgrade job (e.g., VA_UPGRADE). | [required]
**TargetId** | **String** | Unique identifier of the target for the upgrade job. | [required]
**ManagedProcessConfiguration** | [**ClusterManualUpgradeJobsInnerManagedProcessConfiguration**](cluster-manual-upgrade-jobs-inner-managed-process-configuration) | | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInner = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInner -Uuid 4732440c-dacb-45b2-b2f8-ee2fa1327a07 `
-Cookbook 4732440c-dacb-45b2-b2f8-ee2fa1327a07 `
-State PENDING `
-Type VA_UPGRADE `
-TargetId 9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2 `
-ManagedProcessConfiguration null
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInner | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration
title: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Charon** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon) | | [optional]
**Ccg** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg) | | [optional]
**OtelAgent** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent) | | [optional]
**Relay** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay) | | [optional]
**Toolbox** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox) | | [optional]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfiguration = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration -Charon null `
-Ccg null `
-OtelAgent null `
-Relay null `
-Toolbox null
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfiguration | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | **String** | Version of the 'ccg' process. | [required]
**Path** | **String** | Path to the 'ccg' process. | [required]
**Description** | **String** | A brief description of the 'ccg' process. | [required]
**RestartNeeded** | **Boolean** | Indicates whether the process needs to be restarted. | [required]
**Dependencies** | **map[string]String** | A map of dependencies for the 'ccg' process. | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg -Version 1798_1054_241.0.0 `
-Path sailpoint/ccg `
-Description CCG Deployment through ops-cli `
-RestartNeeded true `
-Dependencies {IQService=743/IQService-743.zip, connector-bundle-jdbc=432/connector-bundle-jdbc-432.zip, connector-bundle-misc=437/connector-bundle-misc-437.zip, connector-bundle-unix=242/connector-bundle-unix-242.zip, connector-common-config=208/connector-common-config-208.zip, connector-bundle-filebased=222/connector-bundle-filebased-222.zip, connector-bundle-imprivata=3/connector-bundle-imprivata-3.zip, connector-bundle-mainframe=211/connector-bundle-mainframe-211.zip, connector-bundle-directories=681/connector-bundle-directories-681.zip, connector-bundle-sap-on-prem=196/connector-bundle-sap-on-prem-196.zip, connector-bundle-webservices=1535/connector-bundle-webservices-1535.zip, connector-bundle-sap-cloud-app=175/connector-bundle-sap-cloud-app-175.zip, connector-bundle-healthcare-epic=302/connector-bundle-healthcare-epic-302.zip, connector-bundle-hrms-oraclefusionhcm=166/connector-bundle-hrms-oraclefusionhcm-166.zip, connector-bundle-collaboration-connectors=246/connector-bundle-collaboration-connectors-246.zip}
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | **String** | Version of the 'charon' process. | [required]
**Path** | **String** | Path to the 'charon' process. | [required]
**Description** | **String** | A brief description of the 'charon' process. | [required]
**RestartNeeded** | **Boolean** | Indicates whether the process needs to be restarted. | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon -Version 3047 `
-Path sailpoint/charon `
-Description version of charon used by the va `
-RestartNeeded true
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | **String** | Version of the 'otel_agent' process. | [required]
**Path** | **String** | Path to the 'otel_agent' process. | [required]
**Description** | **String** | A brief description of the 'otel_agent' process. | [required]
**RestartNeeded** | **Boolean** | Indicates whether the process needs to be restarted. | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent -Version 3003 `
-Path sailpoint/otel_agent `
-Description version of otel_agent used by the va `
-RestartNeeded true
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | **String** | Version of the 'relay' process. | [required]
**Path** | **String** | Path to the 'relay' process. | [required]
**Description** | **String** | A brief description of the 'relay' process. | [required]
**RestartNeeded** | **Boolean** | Indicates whether the process needs to be restarted. | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay -Version 3000 `
-Path sailpoint/relay `
-Description version of relay used by the va `
-RestartNeeded true
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox']
slug: /tools/sdk/powershell/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | **String** | Version of the 'toolbox' process. | [required]
**Path** | **String** | Path to the 'toolbox' process. | [required]
**Description** | **String** | A brief description of the 'toolbox' process. | [required]
**RestartNeeded** | **Boolean** | Indicates whether the process needs to be restarted. | [required]
## Examples
- Prepare the resource
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox = Initialize-PSSailpoint.V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox -Version 3004 `
-Path sailpoint/toolbox `
-Description version of toolbox used by the va `
-RestartNeeded true
```
- Convert the resource to JSON
```powershell
$ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox | ConvertTo-JSON
```
[[Back to top]](#)