[2.2301.540.45445] Mutexes and Improvements to REST API interactions

[arudell]

With the latest version of SdnDiagnostics module, there are several improvements that have been made that users should be aware of, as may impact existing scripts or commands.

• Added new API endpoints that can be queried from Network Controller
  

• Added Get-SdnApiEndpoint as exported function, to allow users to generate the API used for invoking operations to REST API of NC.

• Updated Get-SdnResource with new parameters:

  • Renamed ResourceType --> Resource
  • Added InstanceId
  • Added ResourceId

• Renamed Get-SdnApiResource --> Invoke-SdnResourceDump

• Implemented mutexes to handle file lock operations to prevent conflict when writing to files locally on the system, such as trace file, especially during some operations where multiple runspace instances are being used.

Examples of Get-SdnResource

Resource

When specify the -Resource parameter, you can select from a list of API endpoints that are available with Network Controller. You can tab complete or start typing the resource name which will use argument completer to fill in the values.

Get-SdnResource -NcUri https://ncnorthbound.sdn.lab -Resource Credentials

ResourceId

In scenarios where you may want to isolate down to a single object when using -Resource, you can provide an optional -ResourceId parameter, which allows you to specify the resourceId of the object.

Get-SdnResource -NcUri https://ncnorthbound.sdn.lab -Resource Credentials -ResourceId NCHostUser

InstanceId

Network Controller itself will often make references to the instanceId of a resource, which is not easily translatable to what the actual resource is. In these scenarios, you can specify the -InstanceId parameter which will query the NC REST API endpoint to identify what the resource is.

Get-SdnResource -NcUri https://ncnorthbound.sdn.lab -InstanceId cf0ba15b-03a3-4f86-835a-dad5679d1c42