8.7.2 AddPushTarget Method
This Method is used to add a PubSubKeyPushTarget to a PubSubKeyPushTargetFolder or to return an existing Object if the parameters match the configuration of an existing Object.
The Client shall be authorized to modify the configuration for the SKS functionality and shall use at least a signed communication channel when invoking this Method on the Server.
Signature
AddPushTarget (
[in] String ApplicationUri,
[in] String EndpointUrl,
[in] String SecurityPolicyUri,
[in] UserTokenPolicy UserTokenType,
[in] UInt16 RequestedKeyCount,
[in] Duration RetryInterval,
[out] NodeId PushTargetId
);
| Argument | Description |
| ApplicationUri | ApplicationUri of the Server that is the target of the key push. The ApplicationUri is used as name of the resulting PubSubKeyPushTarget object. |
| EndpointUrl | URL of the Endpoint of the Server that is the target of the key push |
| SecurityPolicyUri | Security policy the SKS shall use to establish a secure connection to the PushTarget |
| UserTokenType | The user token type used for the push. The default is Anonymous. |
| RequestedKeyCount | The number of keys to push on each call |
| RetryInterval | Interval the SKS shall use to retry pushing keys after an error appeared |
| PushTargetId | The NodeId of the added PubSubKeyPushTarget Object. |
Method Result Codes
| ResultCode | Description |
| Bad_NodeIdExists | A PushTarget with the ApplicationUri already exists but the arguments do not match the existing object. |
| Good_DataIgnored | A Object with the configuration already exists and was returned without adding a new Object. |
| Bad_InvalidArgument | One of the input arguments is invalid. The InputArgumentResult provides further details. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the object. |
| Bad_SecurityModeInsufficient | The communication channel is not using signing. |
Table 227 specifies the AddressSpace representation for the AddPushTarget Method.
| Attribute | Value | ||||
| BrowseName | AddPushTarget | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model SKS Push |