PowerCLI и REST API Запросы

Connecting to REST APIs

• REST APIs use HTTP/HTTPS for server connections.
• Requests are sent as URIs. Responses can be XML, HTML, or JSON.
• REST is stateless; servers don't remember previous requests. All necessary information (credentials, etc.) must be included in each request.
• Port 443/TCP is required for REST API requests to NSX Manager.

PowerCLI and REST API Requests

• Invoke-RestMethod cmdlet sends HTTP/HTTPS requests.
• The -Uri parameter is required for Invoke-RestMethod. Numerous other parameters exist for customization, including -Method, -Headers, -Body, and many more.
• Example of connecting to a NSX Manager API and retrieving connection details using Invoke-RestMethod:
  • Connect to vCenter Server (Connect-VIServer).
  • Set variables for NSX Manager ($NSXManager), username ($Username), and password ($Password).
  • Convert credentials to Base64 ($base64AuthInfo).
  • Create headers ($Headers) using $base64AuthInfo.
  • Set URI for API call ($Uri). Example: /api/2.0/services/vcconfig (HTTPS required).
  • Use Invoke-RestMethod to retrieve data ($xml). Response likely contains XML data.
  • Access data within the response (e.g., $xml.vcInfo) for specific information, like IP address, username, certificate details of connected vCenter.
  • Example error: "The underlying connection was closed..." often indicates SSL/TLS issues. A prior vCenter connection is frequently required.
  • Use -Method Get with Invoke-RestMethod.
  • The Invoke-RestMethod cmdlet offers extensive parameters for controlling requests (e.g., -Method, -Headers, -Body). The full parameter list, including the available HTTP methods (Get, Post, Put, Delete), should be consulted.
• Example of retrieving data, with Invoke-RestMethod parameters: - $xml = Invoke-RestMethod -Uri $Uri -Method Get -Headers $Headers. - $xml.vcInfo accesses the connection information (e.g., ip address, username) within the response.

Error Handling and Tips

• SSL/TLS issues (e.g., "The underlying connection was closed...") may require a prior vCenter connection.
• Refer to the NSX vSphere API Guide for information about endpoints and format.
• Use VMware Hands-on Labs (e.g., HOL-1703-SDC-1) to practice and use the SEND TEXT button.
• Use the Connect-VIServer cmdlet to establish a vCenter connection.
• Use Base64 encoding ($base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$Username:$Password"))`) to securely handle credentials.
• Create headers ($Headers = @{Authorization = "Basic $base64AuthInfo"}) for authentication in HTTP requests.

Изучите, как использовать PowerCLI для подключения к REST API. Вопросы охватывают основные принципы работы с API и методами отправки запросов, включая примеры командлетов и параметров. Подходите к вопросникам о том, как управлять соединениями и аутентификацией.