### URI provisioning example Source: https://docs.pexip.com/apps/about_windows_app.htm Example URI with Base64-encoded settings. Clicking the link populates the app with the configured settings. ```text pexip-provision://settings/?data=YWxpYXM9YWxpY2VAcGV4YW1wbGUuY29tJnZpZGVvUXVhbGl0eT1oaWdoJmRlZmF1bHRKb2luPXZpZGVvJm11dGVNaWNyb3Bob25lT25Kb2luPXRydWU= ``` -------------------------------- ### List available languages Source: https://docs.pexip.com/aims/configuration.htm Run 'aims-config languages-list-available' to get a list of all languages currently installed and available for enabling on the server. Example output shows 'de-DE,en-US,fr-FR'. ```bash aims-config languages-list-available ``` ```text de-DE,en-US,fr-FR ``` -------------------------------- ### Configure apt proxy for software upgrades Source: https://docs.pexip.com/rp_turn/rp_advanced_config.htm Configure the appliance's operating system to use a proxy for software upgrades. Create the proxy configuration file with nano, add the proxy settings (using the example with actual credentials), save with Ctrl+O, exit with Ctrl+X, and verify with sudo apt-get update. ```bash sudo nano /etc/apt/apt.conf.d/proxy.conf ``` ```plaintext Acquire { HTTP::proxy "http://user:password@proxy.server:port/"; HTTPS::proxy "http://user:password@proxy.server:port/"; } ``` ```plaintext Acquire { HTTP::proxy "http://proxyuser:Abcd$1234@proxy.example.com:8181/"; HTTPS::proxy "http://proxyuser:Abcd$1234@proxy.example.com:8182/"; } ``` ```bash sudo apt-get update ``` -------------------------------- ### Conference Started JSON Example Source: https://docs.pexip.com/admin/api_event_sink.htm Example of a conference_started event message, containing conference properties such as service type and start time. ```json { "data": { "guests_muted": false, "is_locked": false, "is_started": false, "name": "meet.webapp", "service_type": "conference", "start_time": 1559897886.582629, "tag": "" }, "event": "conference_started", "node": "10.47.2.21", "seq": 2, "time": 1559897886.582799, "version": 2 } ``` -------------------------------- ### Registration alias GET request example Source: https://docs.pexip.com/admin/external_policy_requests.htm Example GET request for a registration alias of alice@example.com. The query parameters include pseudo_version_id, protocol, location, version_id, remote_address, node_ip, and auth_type. ```http GET /example.com/policy/v1/registrations/alice@example.com?pseudo_version_id=36402.0.0&protocol=webrtc&location=london&version_id=16&remote_address=10.44.151.5&node_ip=10.44.155.21&auth_type="credentials" ``` -------------------------------- ### POST /api/admin/command/v1/platform/snapshot/ Source: https://docs.pexip.com/api_manage/api_command.htm Take a system snapshot. ```APIDOC ## POST /api/admin/command/v1/platform/snapshot/ ### Description Take a system snapshot. ### Method POST ### Endpoint /api/admin/command/v1/platform/snapshot/ ### Parameters #### Request Body - **name** (string) - Required - The name of the snapshot. ### Request Example { "name": "snapshot-name" } ### Response #### Success Response (200) - **status** (string) - The status of the operation. #### Response Example { "status": "success" } ``` -------------------------------- ### Example: Create equipment resource mailbox Source: https://docs.pexip.com/admin/scheduling_exchange_config.htm Example command that creates an equipment resource named "Pexip Scheduling Service" with alias pexip.scheduling. ```powershell New-Mailbox -Equipment -Name "Pexip Scheduling Service" -Alias pexip.scheduling -DisplayName "Pexip Scheduling Service" ``` -------------------------------- ### GET request for directory information Source: https://docs.pexip.com/admin/external_policy_requests.htm Example of a GET request for directory information where the search string is 'ali'. ```http GET /example.com/policy/v1/registrations?q=ali®istration_alias=bob@example.com&limit=10&location=london&node_ip=10.44.155.21&pseudo_version_id=77683.0.0&version_id=35 ``` -------------------------------- ### Show first-time Teams Connector deployment steps Source: https://docs.pexip.com/admin/teams_pw.htm Displays the manual post-deployment steps for a first-time Teams Connector deployment: DNS records, CVI app consent, and Event Hub connection string update. Includes a conditional step for private routing when $PxUsePrivateRouting is true. ```powershell Write-Host Write-Host "1) Set up a public DNS A record for $($PxTeamsConnFqdn) pointing to the Public IP of " Write-Host " the load balancer ($($publicIpAddress))" Write-Host Write-Host "2) Give consent to the CVI app. Go to: $AdminConsentUrl" Write-Host Write-Host " If Management Consent Source Address prefixes are defined, the administrator" Write-Host " doing consent must come from one of these addresses (or subnets)." Write-Host " Consent address prefixes: $($PxConsentSourceAddressPrefixes)" Write-Host Write-Host "3) Update the Management Node setting 'Azure Event Hub connection string' for $($PxTeamsConnFqdn) to:" Write-Host " $($eventHubKey.PrimaryConnectionString)" Write-Host if ($PxUsePrivateRouting) { Write-Host "4) Set up a private DNS A record for $($PxTeamsConnFqdn) pointing to the (private) frontend IP of " Write-Host " the internal load balancer ($($privateIpAddress))" Write-Host " See: https://docs.pexip.com/admin/teams_routing.htm#enabling" } Write-Host Write-Host "`n--------------------------`n" Write-Host Write-Host ``` -------------------------------- ### Event Sink Started JSON Example Source: https://docs.pexip.com/admin/api_event_sink.htm Example of an eventsink_started message, which confirms the time an event sink was configured. ```json { "node": "10.44.99.2", "seq": 1, "version": 2, "time": 1559897774.520606, "data": {}, "event": "eventsink_started" } ``` -------------------------------- ### GET request for participant properties Source: https://docs.pexip.com/admin/external_policy_requests.htm Example of a GET request for participant properties when a SIP endpoint dials a VMR. ```http GET /example.com/policy/v1/participant/properties?call_direction=dial_in&protocol=sip&bandwidth=0&vendor=Cisco/CE&encryption=On®istered=False&trigger=invite&remote_display_name=Alice&remote_alias=sip:alice@example.com&remote_address=10.44.151.5&remote_port=64410&call_tag=&idp_uuid=&has_authenticated_display_name=False&supports_direct_media=False&teams_tenant_id=&location=London&node_ip=10.144.101.21&version_id=35&pseudo_version_id=77683.0.0&preauthenticated_role=chair&bypass_lock=False&receive_from_audio_mix=main&display_count=&participant_type=standard&participant_uuid=a13e1e71&local_alias=meet.bob&call_uuid=a13e1e71&breakout_uuid=&send_to_audio_mixes_mix_name=main&send_to_audio_mixes_prominent=False&unique_service_name=meet.bob&service_name=meet.bob&service_tag= ``` -------------------------------- ### POST /api/admin/command/v1/platform/backup_create/ Source: https://docs.pexip.com/api_manage/api_command.htm Create a backup of the platform. ```APIDOC ## POST /api/admin/command/v1/platform/backup_create/ ### Description Create a backup of the platform. ### Method POST ### Endpoint /api/admin/command/v1/platform/backup_create/ ### Parameters #### Request Body - **name** (string) - Required - The name of the backup. ### Request Example { "name": "backup-name" } ### Response #### Success Response (200) - **status** (string) - The status of the operation. #### Response Example { "status": "success" } ```