OutboundConnection

Description

This resource shall represent the connection configuration necessary to connect to a remote client. Services shall initiate the outbound connection over a WebSocket defined in the ‘Outbound connections’ clause of the Redfish Specification.

Fields

Field	Type	Description
`Authentication`	`AuthenticationType`	This property shall contain the authentication mechanism for the WebSocket connection.
`Certificates`	`CertificateCollection`	This property shall contain a link to a resource collection of type `CertificateCollection` that represents the server certificates for the remote client referenced by the `EndpointURI` property. If the `Authentication` property contains `MTLS`, the service shall compare the certificates in this collection with the certificate obtained during handshaking with the WebSocket service to verify the identity of the remote client prior to completing the connection. If the remote client cannot be verified, the service shall not complete the connection. Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.
`ClientCertificates`	`CertificateCollection`	This property shall contain a link to a resource collection of type `CertificateCollection` that represents the client identity certificates for the service. If the `Authentication` property contains `MTLS`, these certificates are provided to the remote client referenced by the `EndpointURI` property as part of TLS handshaking.
`ConnectionEnabled`	`boolean`	This property shall indicate if the outbound connection is enabled. If `true`, the service shall attempt to establish an outbound connection to the remote client specified by the `EndpointURI` property. If `false`, the service shall not attempt to establish a connection to the remote client and shall close the connection if one is already established. When a connection is established, the service shall create a Session resource to represent the active connection. When a connection is closed, the service shall delete the connection’s respective Session resource. If the client does not provide this property, the service shall default this value to `true`.
`Description`	`Description`
`EndpointURI`	`string`	This property shall contain the WebSocket URI to the external web service of the remote client. The value shall follow the URI format defined in RFC6455. Services shall reject URIs that do not contain the scheme `wss`.
`Id`	`Id`
`Links`	`Links`	This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
`Name`	`Name`
`Oem`	`Oem`	This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements.
`PreUpgradeHTTPHeaders`	`HTTPHeaderProperty`	This property shall contain an object consisting of the names and values of HTTP headers to send to the remote client during the initial connection prior to the WebSocket upgrade. This property shall be an empty object in responses.
`RetryPolicy`	`RetryPolicyType`	This property shall contain the retry policy for this outbound connection. If not specified by the client in the create request, the service shall assume ConnectionRetryPolicy contains `None`.
`Roles`	`array`	This property shall contain the Redfish roles that contain the privileges of the remote client for the outbound connection.
`Status`	`Status`	This property shall contain any status or health properties of the resource.
`WebSocketPingIntervalMinutes`	`integer`	This property shall contain the interval for the service to send the WebSocket ping opcode to the remote client in minutes. If `0`, the service shall not send the WebSocket ping opcode to the remote client.