RPS Instance Definition Node

Last updated on June 28, 2021.

Last Reviewed and Approved on PENDING REVIEW

Intended Audience

This document is intended for use by a developer.

Introduction

RPS Instance Definition Nodes are definitions for nodes that can be created and associated with Instance Definitions.

Terms and Definitions

  • Instance Definition A layer on top of existing RPS Types that translates a high-level request into the low-level commands required to perform an operation.
  • Instance Definition Reference The assignment of the Instance Definition to a root Resource Item, which results in a set of one or more Resource Items to be run.
  • Instance Definition Item The item on the Instanace Definition layer on top of existing RPS Types.
  • Instance Definition Node A node item that will result in an association of a node with target items that are created when an Instance Definition is invoked.

Creating, Getting, Setting, and Removing an Instance Definition Node

Before activating any software, you must establish your working session. To do so, execute the following PowerShell Command in PowerShell ISE Administrator Mode.

Important

Start by establishing your working session in PowerShell ISE Administrator Mode.

  1. Click on the Search Icon from the Start Menu. Click on Search Icon Figure 1: Click on Search Icon.

  2. Search for PowerShell ISE by typing PowerShell ISE in the Search bar. Search for PowerShell ISE Figure 2: Search for PowerShell ISE.

  3. Click on Run as administrator. Open PowerShell ISE as Administrator Figure 3: Open PowerShell ISE as Administrator.

Creating an Instance Definition Node

Create new Instance Definition Node with only the required parameters.

New-RpsInstanceDefinitionNode -EntityName ConcreteName1 -Name Name1 -HostName microsoft.com -IPAddress 10.10.10.10

Create new Instance Definition Node with all parameters.

New-RpsInstanceDefinitionNode -EntityName ConcreteName1 -Name Name1 -HostName microsoft.com -IPAddress 10.10.10.10 -SyncEndpointUrl microsoft.com/sync -CertificateThumbprint xyz123 -PollingInterval 500

Create new Instance Definition Node with additional properties.

New-RpsInstanceDefinitionNode -EntityName ConcreteName1 -Name Name1 -HostName microsoft.com -IPAddress 10.10.10.10 -Properties @{Property1 = 'Value1'}

Getting an Instance Definition Node

Find an Instance Definition Node by ID.

Get-RpsInstanceDefinitionNode -Id $lookupId

Find an Instance Definition Node by name.

Get-RpsInstanceDefinitionNode -Name $lookupName

Setting an Instance Definition Node

Updates Instance Definition Node. If it doesn't exist, it will create a new Instance Definition Node.

Set-RpsInstanceDefinitionNode

Removing an Instance Definition Node

Delete Instance Definition Node by ID or by object.

Remove-RpsInstanceDefinitionNode -Id "8825A09C-CCE3-4BB0-BCE1-03B4729AC423"
Remove-RpsInstanceDefinitionNode -InstanceDefinitionNode $instanceDefinitionNode

More Resources