### Update Change Deployment Schedule

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Set-SDPChangeDeploymentSchedule.md

This example demonstrates how to update the actual start time for a specific deployment schedule on a given change. Ensure you have the correct Change ID and Deployment Schedule ID.

```powershell
Set-SDPChangeDeploymentSchedule -ChangeId '12345' -Id '1' -ActualStartTime (Get-Date)
```

--------------------------------

### Install Umbrella Module

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/README.md

Installs the main 'ManageEngine.ServiceDesk.OnPrem' module from the PowerShell Gallery, which includes all sub-modules.

```powershell
Install-PSResource -Name 'ManageEngine.ServiceDesk.OnPrem' -Repository PSGallery
```

--------------------------------

### Install Development Modules

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/CONTRIBUTING.md

Installs the necessary PowerShell modules for development. Use -Force for Pester if it's already installed.

```powershell
Install-Module platyPS -Scope CurrentUser
Install-Module Pester  -Scope CurrentUser -Force
```

--------------------------------

### Manage Users (Requesters)

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for retrieving, creating, updating, and removing users (requesters).

```powershell
Get-SDPUser
```

```powershell
Get-SDPUser -Id '12345'
```

```powershell
New-SDPUser -Name 'Alice Brown' -EmailId 'abrown@example.com' -Phone '555-1234'
```

```powershell
Set-SDPUser -Id '12345' -Phone '555-5678'
```

```powershell
Remove-SDPUser -Id '12345'
```

--------------------------------

### Manage Problem Templates

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for retrieving, creating, updating, and removing problem templates.

```powershell
Get-SDPProblemTemplate
```

```powershell
New-SDPProblemTemplate -Name 'Exchange Outage'
```

```powershell
Set-SDPProblemTemplate -Id '1' -Name 'Exchange Outage v2'
```

```powershell
Remove-SDPProblemTemplate -Id '1'
```

--------------------------------

### Retrieve all priority matrix entries

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPPriorityMatrix.md

This example shows how to call the Get-SDPPriorityMatrix cmdlet without any parameters to retrieve all available priority matrix entries. The cmdlet defaults to fetching records with a page size of 100 starting from index 1.

```powershell
Get-SDPPriorityMatrix
```

--------------------------------

### Create a New Technician

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPTechnician.md

This example demonstrates how to create a new technician by providing their name and email address.

```powershell
New-SDPTechnician -Name 'Bob Jones' -EmailId 'bjones@example.com'
```

--------------------------------

### Invoke-SDPRestMethod - Get List of Requests

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Core/en-US/Invoke-SDPRestMethod.md

Example of using Invoke-SDPRestMethod to retrieve a list of requests, specifying the 'requests' endpoint and providing list information via InputData.

```powershell
Invoke-SDPRestMethod -Endpoint 'requests' -InputData @{ list_info = @{ row_count = 10 } }
```

--------------------------------

### Manage Task Dependencies

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for adding, retrieving, and removing dependencies between problem tasks.

```powershell
Add-SDPProblemTaskDependency -ProblemId '12345' -TaskId '1' -DependsOnTaskId '2'
```

```powershell
Get-SDPProblemTaskDependency -ProblemId '12345' -TaskId '1'
```

```powershell
Remove-SDPProblemTaskDependency -ProblemId '12345' -TaskId '1' -DependsOnTaskId '2'
```

--------------------------------

### Convert a Single Technician to a User

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Convert-SDPTechnicianToUser.md

This example demonstrates how to convert a single technician to a user by providing their ID.

```powershell
Convert-SDPTechnicianToUser -Id '12345'
```

--------------------------------

### Add a Worklog Entry to a ServiceDesk Plus Problem

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/New-SDPProblemWorklog.md

This example demonstrates how to add a worklog entry to a specific problem using the New-SDPProblemWorklog cmdlet. It includes the problem ID, a description of the work, the owner's name, and the start and end times for the worklog.

```powershell
New-SDPProblemWorklog -ProblemId '12345' -Description 'Investigated root cause' -OwnerName 'Bob Jones' -StartTime (Get-Date).AddHours(-2) -EndTime (Get-Date)
```

--------------------------------

### Manage Problem Notes

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, updating, and removing notes associated with a problem.

```powershell
New-SDPProblemNote -ProblemId '12345' -Description 'Escalated to Tier 2.'
```

```powershell
Get-SDPProblemNote -ProblemId '12345'
```

```powershell
Set-SDPProblemNote -ProblemId '12345' -Id '1' -Description 'Updated note.'
```

```powershell
Remove-SDPProblemNote -ProblemId '12345' -Id '1'
```

--------------------------------

### Retrieve all change closure rules

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeClosureRule.md

This example shows how to retrieve all change closure rules using the Get-SDPChangeClosureRule cmdlet without any specific parameters. It defaults to retrieving records with a page size of 100 and starting from the first record.

```powershell
Get-SDPChangeClosureRule
```

--------------------------------

### Update Change Status Example

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Set-SDPChangeStatus.md

This example demonstrates how to update the status of a change with a specific ID to 'Approved'.

```powershell
Set-SDPChangeStatus -Id '1' -Name 'Approved'
```

--------------------------------

### Manage Task Worklogs

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, and removing worklogs associated with problem tasks.

```powershell
New-SDPProblemTaskWorklog -ProblemId '12345' -TaskId '1' -Description 'Patched affected nodes' -OwnerName 'Bob Jones' -StartTime (Get-Date).AddHours(-1) -EndTime (Get-Date)
```

```powershell
Get-SDPProblemTaskWorklog -ProblemId '12345' -TaskId '1'
```

```powershell
Remove-SDPProblemTaskWorklog -ProblemId '12345' -TaskId '1' -Id '1'
```

--------------------------------

### Add-SDPProblemTaskCommentReply Example

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Add-SDPProblemTaskCommentReply.md

This example demonstrates how to reply to a specific comment on a task within a ServiceDesk Plus problem. Ensure you have the correct Problem ID, Task ID, and Comment ID.

```powershell
Add-SDPProblemTaskCommentReply -ProblemId '12345' -TaskId '1' -CommentId '5' -Description 'Agreed, proceeding with that approach.'
```

--------------------------------

### Manage Problem Worklogs

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, and removing worklogs directly associated with a problem.

```powershell
New-SDPProblemWorklog -ProblemId '12345' -Description 'Investigated root cause' -OwnerName 'Bob Jones' -StartTime (Get-Date).AddHours(-2) -EndTime (Get-Date)
```

```powershell
Get-SDPProblemWorklog -ProblemId '12345'
```

```powershell
Remove-SDPProblemWorklog -ProblemId '12345' -Id '1'
```

--------------------------------

### Manage Technicians

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for retrieving, creating, updating, removing, and converting users to technicians and vice versa.

```powershell
Get-SDPTechnician
```

```powershell
Get-SDPTechnician -Id '12345'
```

```powershell
New-SDPTechnician -Name 'Bob Jones' -EmailId 'bjones@example.com' -JobTitle 'L2 Engineer'
```

```powershell
Set-SDPTechnician -Id '12345' -JobTitle 'L3 Engineer'
```

```powershell
Remove-SDPTechnician -Id '12345'
```

```powershell
Convert-SDPUserToTechnician -Id '12345'
```

```powershell
Convert-SDPTechnicianToUser -Id '12345'
```

--------------------------------

### Manage Problem Tasks

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, updating, removing, and invoking actions on tasks associated with a problem.

```powershell
New-SDPProblemTask -ProblemId '12345' -Title 'Analyse affected systems' -OwnerName 'Bob Jones'
```

```powershell
Get-SDPProblemTask -ProblemId '12345'
```

```powershell
Set-SDPProblemTask -ProblemId '12345' -Id '1' -StatusName 'Completed'
```

```powershell
Remove-SDPProblemTask -ProblemId '12345' -Id '1'
```

```powershell
Invoke-SDPProblemTaskTrigger -ProblemId '12345' -Id '1'
```

```powershell
Invoke-SDPProblemTaskMark -ProblemId '12345' -Id '1'
```

```powershell
Close-SDPProblemTask -ProblemId '12345' -Id '1'
```

```powershell
Set-SDPProblemTaskAssignment -ProblemId '12345' -Id '1' -TechnicianName 'Bob Jones'
```

--------------------------------

### Retrieve all change types

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeType.md

This example shows how to retrieve all available change types using the default parameters.

```powershell
Get-SDPChangeType
```

--------------------------------

### Create a New Problem Template

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/New-SDPProblemTemplate.md

This example demonstrates how to create a new problem template with a specified name and description.

```powershell
New-SDPProblemTemplate -Name 'Network Outage Investigation' -Description 'Standard template for network outage problems.'
```

--------------------------------

### Manage Organization Users

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for retrieving, creating, updating, and removing organization users (portal accounts).

```powershell
Get-SDPOrgUser
```

```powershell
Get-SDPOrgUser -Id '12345'
```

```powershell
New-SDPOrgUser -Name 'Jane Smith' -LoginName 'jsmith' -EmailId 'jsmith@example.com'
```

```powershell
Set-SDPOrgUser -Id '12345' -JobTitle 'Senior Analyst'
```

```powershell
Remove-SDPOrgUser -Id '12345'
```

--------------------------------

### Manage Problem Analysis Sub-resources

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for adding, retrieving, and updating root cause, symptoms, and impact details for a problem.

```powershell
Add-SDPProblemRootCause -ProblemId '12345' -Content 'Memory leak in service X.'
```

```powershell
Get-SDPProblemRootCause -ProblemId '12345'
```

```powershell
Set-SDPProblemRootCause -ProblemId '12345' -Content 'Updated root cause analysis.'
```

```powershell
Add-SDPProblemSymptoms -ProblemId '12345' -Content 'Servers restart every 6 hours.'
```

```powershell
Get-SDPProblemSymptoms -ProblemId '12345'
```

```powershell
Set-SDPProblemSymptoms -ProblemId '12345' -Content 'Updated symptoms.'
```

```powershell
Add-SDPProblemImpactDetails -ProblemId '12345' -Content 'Affects 500 users in the London office.'
```

```powershell
Get-SDPProblemImpactDetails -ProblemId '12345'
```

```powershell
Set-SDPProblemImpactDetails -ProblemId '12345' -Content 'Updated impact details.'
```

--------------------------------

### Manage Task Comments

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, updating, replying to, and removing comments on problem tasks.

```powershell
New-SDPProblemTaskComment -ProblemId '12345' -TaskId '1' -Content 'Started investigation.'
```

```powershell
Get-SDPProblemTaskComment -ProblemId '12345' -TaskId '1'
```

```powershell
Set-SDPProblemTaskComment -ProblemId '12345' -TaskId '1' -Id '1' -Content 'Updated.'
```

```powershell
Add-SDPProblemTaskCommentReply -ProblemId '12345' -TaskId '1' -CommentId '1' -Content 'Acknowledged.'
```

```powershell
Remove-SDPProblemTaskComment -ProblemId '12345' -TaskId '1' -Id '1'
```

--------------------------------

### Create a New User

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPUser.md

This example demonstrates how to create a new user with essential details like name, login name, and email address.

```powershell
New-SDPUser -Name 'John Doe' -LoginName 'jdoe' -EmailId 'jdoe@example.com'
```

--------------------------------

### Create a New Site

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPSite.md

This example demonstrates how to create a new site named 'Austin HQ' with specified city, state, and country details.

```powershell
New-SDPSite -Name 'Austin HQ' -City 'Austin' -State 'TX' -Country 'USA'
```

--------------------------------

### Add Worklog to Problem Task

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/New-SDPProblemTaskWorklog.md

Example of adding a worklog entry to a specific task within a ServiceDesk Plus problem. This includes specifying the problem ID, task ID, a description of the work, the owner, and the start and end times.

```powershell
New-SDPProblemTaskWorklog -ProblemId '12345' -TaskId '1' -Description 'Ran diagnostics' -OwnerName 'Bob Jones' -StartTime (Get-Date).AddHours(-1) -EndTime (Get-Date)
```

--------------------------------

### Create a New Org User

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPOrgUser.md

This example demonstrates how to create a new organizational user by providing the required Name, LoginName, and EmailId parameters.

```powershell
New-SDPOrgUser -Name 'Jane Smith' -LoginName 'jsmith' -EmailId 'jsmith@example.com'
```

--------------------------------

### Quick Start Usage

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/README.md

Demonstrates the basic workflow for connecting to the ServiceDesk Plus API, retrieving a request and a change by ID, and disconnecting. Ensure you have a valid technician API key.

```powershell
$key = Get-Secret -Name 'SdpTechnicianKey'
Connect-SDPService -BaseUri 'https://sdp.corp.local:8080' -TechnicianKey $key

Get-SDPRequest -Id '12345'
Get-SDPChange  -Id '12345'

Disconnect-SDPService
```

--------------------------------

### Create a New Department with Department Head and Site IDs

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPDepartment.md

This example demonstrates creating a new department by specifying the department head's user ID and the site ID. Ensure these IDs are valid within your ServiceDesk Plus instance.

```powershell
New-SDPDepartment -Name 'IT' -DepartmentHeadId '5' -SiteId '3'
```

--------------------------------

### Connect to ServiceDesk Plus with interactive API key input

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Core/en-US/Connect-SDPService.md

This example demonstrates how to connect to a ServiceDesk Plus instance using the BaseUri and prompting the user for their TechnicianKey interactively.

```powershell
Connect-SDPService -BaseUri 'https://sdp.corp.local:8080' -TechnicianKey (Read-Host -AsSecureString)
```

--------------------------------

### Update a Change Worklog

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Set-SDPChangeWorklog.md

This example demonstrates how to update the description of a specific worklog entry for a given change ID.

```powershell
Set-SDPChangeWorklog -ChangeId '12345' -Id '1' -Description 'Corrected time entry.'
```

--------------------------------

### Update Support Group Description

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Set-SDPSupportGroup.md

This example demonstrates how to update the description of an existing support group using its ID.

```powershell
Set-SDPSupportGroup -Id '7' -Description 'Network and infrastructure team'
```

--------------------------------

### Remove SDP Problem Task Worklog Example

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Remove-SDPProblemTaskWorklog.md

This example demonstrates how to remove a specific worklog entry from a task associated with a ServiceDesk Plus problem. Ensure you have the correct Problem ID, Task ID, and Worklog ID.

```powershell
Remove-SDPProblemTaskWorklog -ProblemId '12345' -TaskId '1' -Id '67890'
```

--------------------------------

### Update Change Reason

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Set-SDPChangeReason.md

This example demonstrates how to update an existing change reason by specifying its ID and providing a new name.

```powershell
Set-SDPChangeReason -Id '1' -Name 'Security patching'
```

--------------------------------

### Get Approvals

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all pending approvals.

```powershell
# Approvals
Get-SDPApproval
```

--------------------------------

### Get Single Problem

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Fetches a specific problem by its unique ID.

```powershell
# Get a single problem
Get-SDPProblem -Id '12345'
```

--------------------------------

### Get Change Worklogs

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all worklog entries for a specific change.

```powershell
Get-SDPChangeWorklog -ChangeId '12345'
```

--------------------------------

### Create a new support group and assign technicians

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPSupportGroup.md

This example demonstrates how to create a new support group and immediately assign existing technicians to it by their IDs. Ensure technician IDs are valid.

```powershell
New-SDPSupportGroup -Name 'Helpdesk' -TechnicianIds '5','6','7'
```

--------------------------------

### Retrieve Task Dependencies for a Problem

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Get-SDPProblemTaskDependency.md

This example shows how to retrieve task dependencies for a ServiceDesk Plus problem using its ID.

```powershell
Get-SDPProblemTaskDependency -ProblemId '12345'
```

--------------------------------

### Get Change Tasks

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all tasks associated with a given change.

```powershell
Get-SDPChangeTask -ChangeId '12345'
```

--------------------------------

### Create a Detailed Change

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/New-SDPChange.md

This example demonstrates creating a change with a title, change type, priority, and assigned technician. It's useful for setting initial key attributes of a change.

```powershell
New-SDPChange -Title 'Patch management rollout' -ChangeTypeName 'Normal' -PriorityName 'High' -TechnicianName 'Bob Jones'
```

--------------------------------

### Manage Organization Structure (Regions, Sites, Departments, Support Groups)

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, updating, and removing organizational regions, sites, departments, and support groups.

```powershell
New-SDPRegion -Name 'EMEA'
```

```powershell
Get-SDPRegion; Set-SDPRegion -Id '1' -Name 'EMEA Region'; Remove-SDPRegion -Id '1'
```

```powershell
New-SDPSite -Name 'Austin HQ' -City 'Austin' -State 'TX' -Country 'USA'
```

```powershell
Get-SDPSite; Set-SDPSite -Id '1' -Description 'Main campus'; Remove-SDPSite -Id '1'
```

```powershell
New-SDPDepartment -Name 'IT Operations'
```

```powershell
Get-SDPDepartment; Set-SDPDepartment -Id '1' -Name 'IT Ops'; Remove-SDPDepartment -Id '1','2'
```

```powershell
New-SDPSupportGroup -Name 'Service Desk'
```

```powershell
Get-SDPSupportGroup; Set-SDPSupportGroup -Id '1' -Name 'Help Desk'; Remove-SDPSupportGroup -Id '1'
```

--------------------------------

### Get Change Notes

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all notes associated with a given change.

```powershell
Get-SDPChangeNote -ChangeId '12345'
```

--------------------------------

### Get Request Resolution

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves the resolution details for a specific request.

```powershell
Get-SDPRequestResolution -RequestId '12345'
```

--------------------------------

### Get Request Worklogs

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all worklog entries for a specific request.

```powershell
Get-SDPRequestWorklog -RequestId '12345'
```

--------------------------------

### Pick up multiple open problems

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Invoke-SDPProblemPickup.md

This example demonstrates how to pick up multiple problems that are currently in an 'Open' status by piping the results of Get-SDPProblem to Invoke-SDPProblemPickup.

```powershell
Get-SDPProblem -Filter @(@{ field = 'status.name'; condition = 'is'; value = 'Open' }) | Invoke-SDPProblemPickup
```

--------------------------------

### Get Request Notes

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all notes associated with a given request.

```powershell
Get-SDPRequestNote -RequestId '12345'
```

--------------------------------

### Create a Request Task with Additional Details

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Requests/en-US/New-SDPRequestTask.md

This example shows how to create a task with more specific details, including the owner and priority, by utilizing additional parameters.

```powershell
New-SDPRequestTask -RequestId '12345' -Title 'Deploy fix' -OwnerName 'Bob Jones' -PriorityName 'High'
```

--------------------------------

### Get Single Request

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Fetches a specific request by its unique ID.

```powershell
# Get a single request
Get-SDPRequest -Id '12345'
```

--------------------------------

### Retrieve Initiated Requests for a Change with All Results

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeAssociation.md

This example demonstrates how to retrieve all initiated requests for a given change ID. The -All parameter ensures that all associated records are fetched, regardless of pagination.

```powershell
Get-SDPChangeAssociation -ChangeId '12345' -Type InitiatedRequest -All
```

--------------------------------

### Get-SDPProblemTemplate - Get by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Get-SDPProblemTemplate.md

Retrieves a specific problem template by its unique ID.

```APIDOC
## Get-SDPProblemTemplate - Id

### Description
Retrieves a specific problem template from ServiceDesk Plus using its unique identifier.

### Method
GET

### Endpoint
/sdp/api/v3/problemtemplates/{Id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the specific template to retrieve.

### Response
#### Success Response (200)
- **id** (String) - The unique identifier of the template.
- **name** (String) - The name of the template.
- **description** (String) - The description of the template.

#### Response Example
```json
{
  "id": "5",
  "name": "Software Glitch",
  "description": "A template for reporting software-related issues."
}
```
```

--------------------------------

### Get Change Associations

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves associations for a change, optionally filtering by type.

```powershell
Get-SDPChangeAssociation -ChangeId '12345' -Type InitiatedRequest
```

--------------------------------

### Get Change Deployment Schedules

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Retrieves all deployment schedules associated with a change.

```powershell
Get-SDPChangeDeploymentSchedule -ChangeId '12345'
```

--------------------------------

### Get-SDPChange - Get Change by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChange.md

Retrieves a single change by its unique ID.

```APIDOC
## Get-SDPChange - Id

### Description
Retrieves a single change from ServiceDesk Plus using its unique ID.

### Method
GET (Implied by cmdlet structure)

### Endpoint
/api/v3/changes/{id} (Implied by cmdlet structure)

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the change to retrieve.

### Request Example
```json
{
  "Id": "12345"
}
```

### Response
#### Success Response (200)
- **change** (Object) - The change object with details.

#### Response Example
```json
{
  "change": {
    "id": "12345",
    "title": "Update server configuration",
    "status": {"name": "Open"}
  }
}
```
```

--------------------------------

### Build All Modules

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/CONTRIBUTING.md

Executes the build script to generate documentation, run unit tests, and package all modules.

```powershell
# Generate docs + run unit tests + package (all modules)
./build.ps1
```

--------------------------------

### Get-SDPTechnician - Get Technician by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPTechnician.md

Retrieves a single technician by their unique ID.

```APIDOC
## Get-SDPTechnician - Id

### Description
Retrieves a single technician from ServiceDesk Plus using their unique ID.

### Method
GET (Implied)

### Endpoint
/api/v3/technicians/{id} (Implied)

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the technician to retrieve.

### Request Example
```
Get-SDPTechnician -Id '12345'
```

### Response
#### Success Response (200)
- **SDPTechnician** (Object) - The technician object matching the provided ID.

### Response Example
```json
{
  "id": 12345,
  "name": "Jane Smith",
  "email": "jane.smith@example.com"
}
```
```

--------------------------------

### Manage Categorization (Categories, Subcategories, Items)

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/EXAMPLES.md

Examples for creating, retrieving, updating, and removing categories, subcategories, and items for asset categorization.

```powershell
New-SDPCategory -Name 'Hardware'
```

```powershell
Get-SDPCategory; Set-SDPCategory -Id '1' -Name 'Hardware'; Remove-SDPCategory -Id '1'
```

```powershell
New-SDPSubcategory -CategoryId '1' -Name 'Laptops'
```

```powershell
Get-SDPSubcategory -CategoryId '1'; Set-SDPSubcategory -Id '1' -Name 'Laptops'; Remove-SDPSubcategory -Id '1'
```

```powershell
New-SDPItem -SubcategoryId '1' -Name 'Dell XPS 15'
```

```powershell
Get-SDPItem; Set-SDPItem -Id '1' -Name 'Dell XPS 15 (2024)'; Remove-SDPItem -Id '1'
```

--------------------------------

### Get-SDPChangeStatus - Get Change by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeStatus.md

Retrieves a specific change status by its unique ID.

```APIDOC
## Get-SDPChangeStatus - Id

### Description
Retrieves a specific change status from ServiceDesk Plus using its unique ID.

### Method
GET

### Endpoint
/api/v3/changes/status/{id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the change status to retrieve.

### Response
#### Success Response (200)
- **id** (String) - The ID of the change status.
- **name** (String) - The name of the change status.

### Response Example
```json
{
  "id": "1",
  "name": "New"
}
```
```

--------------------------------

### Create a new category with name and description

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPCategory.md

This example demonstrates how to create a new category named 'Hardware' with a corresponding description.

```powershell
New-SDPCategory -Name 'Hardware' -Description 'Hardware-related requests'
```

--------------------------------

### Get-SDPPriority - Get by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPPriority.md

Retrieves a specific priority from ServiceDesk Plus by its unique ID.

```APIDOC
## Get-SDPPriority - Id

### Description
Retrieves a single priority from ServiceDesk Plus using its unique identifier.

### Method
GET

### Endpoint
/api/v3/priorities/{id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the priority to retrieve.

### Response
#### Success Response (200)
- **id** (String) - The unique identifier for the priority.
- **name** (String) - The name of the priority.
- **colorCode** (String) - The color code associated with the priority.
- **displayOrder** (Int32) - The display order of the priority.

### Response Example
```json
{
  "id": "1",
  "name": "High",
  "colorCode": "#FF0000",
  "displayOrder": 1
}
```
```

--------------------------------

### Create a New Public Announcement

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPAnnouncement.md

This example demonstrates how to create a new announcement with a specified title, content, and sets it to be publicly visible.

```powershell
New-SDPAnnouncement -Title 'Planned Maintenance' -Content 'Servers will be offline Saturday 10pm-2am.' -IsPublic
```

--------------------------------

### Delete a Problem Template

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Remove-SDPProblemTemplate.md

This example shows how to delete a specific problem template using its ID.

```powershell
Remove-SDPProblemTemplate -Id '5'
```

--------------------------------

### Remove a Change (Soft Delete)

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Remove-SDPChange.md

This example shows how to remove a change by its ID, moving it to the trash.

```powershell
Remove-SDPChange -Id '12345'
```

--------------------------------

### Convert Multiple Technicians to Users

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Convert-SDPTechnicianToUser.md

This example shows how to convert multiple technicians to users by providing a comma-separated list of their IDs.

```powershell
Convert-SDPTechnicianToUser -Id '111','222','333'
```

--------------------------------

### Create a new support group with name and description

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPSupportGroup.md

Use this snippet to create a new support group and provide a descriptive text for its purpose. This is a basic usage example.

```powershell
New-SDPSupportGroup -Name 'Network Team' -Description 'Handles network issues'
```

--------------------------------

### Connect to ServiceDesk Plus with pre-defined API key and options

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Core/en-US/Connect-SDPService.md

This example shows how to connect to a ServiceDesk Plus instance with a pre-defined API key, specifying a PortalId and skipping certificate checks. The API key is converted to a SecureString.

```powershell
$key = ConvertTo-SecureString 'myapikey' -AsPlainText -Force
Connect-SDPService -BaseUri 'https://sdp.corp.local' -TechnicianKey $key -PortalId 2 -SkipCertificateCheck
```

--------------------------------

### New-SDPSite Cmdlet

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPSite.md

Creates a new site in ServiceDesk Plus by specifying its name and optional location and contact details.

```APIDOC
## New-SDPSite

### Description
Creates a new site in ServiceDesk Plus.

### Syntax
```powershell
New-SDPSite -Name <String> [-Description <String>] [-EmailId <String>] [-City <String>] [-State <String>] [-Country <String>] [-RegionId <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Parameters
#### Path Parameters
* **-Name** (String) - Required - Name of the site.
* **-Description** (String) - Optional - Description of the site.
* **-EmailId** (String) - Optional - Contact email address for the site.
* **-City** (String) - Optional - City where the site is located.
* **-State** (String) - Optional - State or province.
* **-Country** (String) - Optional - Country.
* **-RegionId** (String) - Optional - ID of the region to associate this site with.

### Request Example
```powershell
New-SDPSite -Name 'Austin HQ' -City 'Austin' -State 'TX' -Country 'USA'
```

### Response
This cmdlet does not explicitly define a response body structure in the provided documentation. It is assumed to return information about the created site or indicate success/failure.

### Common Parameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
```

--------------------------------

### Update Subcategory Description

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Set-SDPSubcategory.md

This example demonstrates how to update the description of an existing subcategory using its ID.

```powershell
Set-SDPSubcategory -Id '50' -Description 'Laptop hardware issues'
```

--------------------------------

### Update Announcement Title

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Set-SDPAnnouncement.md

This example demonstrates how to update the title of an existing announcement using its ID.

```powershell
Set-SDPAnnouncement -Id '5' -Title 'Maintenance Rescheduled'
```

--------------------------------

### Create a New Impact

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPImpact.md

This example demonstrates how to create a new impact with a specified name using the New-SDPImpact cmdlet. Ensure the 'Name' parameter is provided.

```powershell
New-SDPImpact -Name 'Custom Impact'
```

--------------------------------

### Remove a Subcategory by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Remove-SDPSubcategory.md

This example demonstrates how to remove a specific subcategory using its unique identifier.

```powershell
Remove-SDPSubcategory -Id '50'
```

--------------------------------

### Retrieve all change risks

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeRisk.md

This example retrieves all available change risks by calling the cmdlet without any parameters. It utilizes the default paging behavior.

```powershell
Get-SDPChangeRisk
```

--------------------------------

### Get-SDPChangeRisk - Get Change Risk by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Get-SDPChangeRisk.md

Retrieves a specific change risk by its unique ID.

```APIDOC
## Get-SDPChangeRisk - Get Change Risk by ID

### Description
Retrieves a single change risk from ServiceDesk Plus using its unique identifier.

### Method
GET

### Endpoint
/api/v3/changes/risks/{Id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the risk to retrieve.

### Response
#### Success Response (200)
- **id** (String) - The ID of the change risk.
- **name** (String) - The name of the change risk.
- **description** (String) - The description of the change risk.

#### Response Example
{
  "id": "1",
  "name": "Low Risk",
  "description": "Low impact change"
}

### Request Example
```powershell
Get-SDPChangeRisk -Id '1'
```
```

--------------------------------

### Get-SDPUser - Get User by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPUser.md

Retrieves a single user from ServiceDesk Plus by their unique ID.

```APIDOC
## Get-SDPUser - Id

### Description
Retrieves a single user from ServiceDesk Plus by their unique ID.

### Method
GET

### Endpoint
/api/v3/users/{userId}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the user to retrieve.
```

--------------------------------

### Create a New Department with Name and Description

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPDepartment.md

Use this snippet to create a new department with a specified name and an optional description. This is a basic usage example.

```powershell
New-SDPDepartment -Name 'Engineering' -Description 'Software engineering teams'
```

--------------------------------

### Retrieve All Problems

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Get-SDPProblem.md

Use the -All switch to retrieve all problems, automatically handling pagination. This is useful for getting a complete dataset.

```powershell
Get-SDPProblem -All
```

--------------------------------

### Get-SDPUrgency - Get Urgency by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPUrgency.md

Retrieves a specific urgency from ServiceDesk Plus by its unique ID.

```APIDOC
## Get-SDPUrgency - Id

### Description
Retrieves a specific urgency from ServiceDesk Plus by its unique ID.

### Method
GET

### Endpoint
/api/v3/settings/urgency/{id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the urgency to retrieve.

### Response
#### Success Response (200)
- **id** (String) - The ID of the urgency.
- **name** (String) - The name of the urgency.
- **colorCode** (String) - The color code associated with the urgency.
- **displayOrder** (Int32) - The display order of the urgency.

### Request Example
```json
{
  "example": "Get-SDPUrgency -Id '1'"
}
```

### Response Example
```json
{
  "example": "{\"id\":\"1\",\"name\":\"High\",\"colorCode\":\"#FF0000\",\"displayOrder\":1}"
}
```
```

--------------------------------

### Get-SDPLevel - Get Level by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/Get-SDPLevel.md

Retrieves a specific ServiceDesk Plus level by its unique ID.

```APIDOC
## Get-SDPLevel - Get Level by ID

### Description
Retrieves a specific ServiceDesk Plus level by its unique ID.

### Method
GET

### Endpoint
/sdp/api/levels/{Id}

### Parameters
#### Path Parameters
- **Id** (String) - Required - The ID of the level to retrieve.

### Response
#### Success Response (200)
- **SDPReference** (object) - Description of the response object structure is not provided in the source.

### Request Example
```powershell
Get-SDPLevel -Id '1'
```

### Response Example
```json
{
  "id": "1",
  "name": "Level 1"
}
```
```

--------------------------------

### Retrieve Problem Symptoms by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Get-SDPProblemSymptoms.md

This example shows how to retrieve the symptoms for a specific problem using its ID. Ensure you have the correct Problem ID.

```powershell
Get-SDPProblemSymptoms -ProblemId '12345'
```

--------------------------------

### Create a New Status

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPStatus.md

This example demonstrates how to create a new status named 'Custom Status' using the New-SDPStatus cmdlet.

```powershell
New-SDPStatus -Name 'Custom Status'
```

--------------------------------

### Update Problem Status

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Set-SDPProblem.md

Updates the status of a specific problem using its ID. This is a basic usage example.

```powershell
Set-SDPProblem -Id '12345' -StatusName 'Open'
```

--------------------------------

### Create a New Reminder

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPReminder.md

This example demonstrates how to create a new reminder with a summary and a future date. The date is set to one day from the current date.

```powershell
New-SDPReminder -Summary 'Follow up on request 25' -Date (Get-Date).AddDays(1)
```

--------------------------------

### Close a Problem by ID

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Problems/en-US/Close-SDPProblem.md

This example demonstrates how to close a ServiceDesk Plus problem using its unique ID.

```powershell
Close-SDPProblem -Id '12345'
```

--------------------------------

### Create a New Change Reason

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/New-SDPChangeReason.md

This example demonstrates how to create a new change reason with a specified name. Ensure the 'Name' parameter is provided.

```powershell
New-SDPChangeReason -Name 'Compliance requirement'
```

--------------------------------

### Update a Change Type

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Set-SDPChangeType.md

This example demonstrates how to update a change type by specifying its ID and new name.

```powershell
Set-SDPChangeType -Id '1' -Name 'Standard'
```

--------------------------------

### Create a New Change Deployment Schedule

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/New-SDPChangeDeploymentSchedule.md

Use this cmdlet to create a new deployment schedule for a specific change. Provide the Change ID, a description, and the scheduled start and end times.

```powershell
New-SDPChangeDeploymentSchedule -ChangeId '12345' -Description 'Maintenance window' -ScheduledStartTime '2026-06-01 02:00' -ScheduledEndTime '2026-06-01 04:00'
```

--------------------------------

### Permanently Remove a Change

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Remove-SDPChange.md

This example demonstrates how to permanently delete a change using its ID and the -Permanent switch.

```powershell
Remove-SDPChange -Id '12345' -Permanent
```

--------------------------------

### Remove a Change Closure Code

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/Remove-SDPChangeClosureCode.md

This example demonstrates how to delete a specific change closure code by its ID.

```powershell
Remove-SDPChangeClosureCode -Id '1'
```

--------------------------------

### Create a Basic Request Task

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Requests/en-US/New-SDPRequestTask.md

This example demonstrates how to create a new task for a ServiceDesk Plus request using the RequestId and Title parameters.

```powershell
New-SDPRequestTask -RequestId '12345' -Title 'Verify network connectivity'
```

--------------------------------

### Retrieve Pending Approvals

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Requests/en-US/Get-SDPApproval.md

This example shows the basic usage of the Get-SDPApproval cmdlet to retrieve a list of pending approvals. It uses default parameter values.

```powershell
Get-SDPApproval
```

--------------------------------

### Create a New Change Role

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Changes/en-US/New-SDPChangeRole.md

This example demonstrates how to create a new change role named 'Change Manager' using the New-SDPChangeRole cmdlet.

```powershell
New-SDPChangeRole -Name 'Change Manager'
```

--------------------------------

### New-SDPRegion Cmdlet

Source: https://github.com/griffeth-barker/manageengine.servicedesk.onprem/blob/main/docs/ManageEngine.ServiceDesk.OnPrem.Admin/en-US/New-SDPRegion.md

Creates a new region in ServiceDesk Plus by specifying its name and an optional description.

```APIDOC
## New-SDPRegion

### Description
Creates a new region in ServiceDesk Plus.

### Syntax
```powershell
New-SDPRegion -Name <String> [-Description <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Parameters
#### Name
Name of the region.
* Type: String
* Required: True
* Position: 1

#### Description
Description of the region.
* Type: String
* Required: False
* Position: 2

#### WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
* Type: SwitchParameter
* Required: False
* Position: Named

#### Confirm
Prompts you for confirmation before running the cmdlet.
* Type: SwitchParameter
* Required: False
* Position: Named

### Examples
#### EXAMPLE 1
```powershell
New-SDPRegion -Name 'North America' -Description 'US and Canada offices'
```
```