wsman.h header
This header is used by Windows Remote Management. For more information, see:
wsman.h contains the following programming interfaces:
Functions
WSManCloseCommand Deletes a command and frees the resources that are associated with it. |
WSManCloseOperation Cancels or closes an asynchronous operation. |
WSManCloseSession Closes a session object. |
WSManCloseShell Deletes a shell object and frees the resources associated with the shell. |
WSManConnectShell Connects to an existing server session. |
WSManConnectShellCommand Connects to an existing command running in a shell. |
WSManCreateSession Creates a session object. |
WSManCreateShell Creates a shell object. |
WSManCreateShellEx Creates a shell object by using the same functionality as the WSManCreateShell function, with the addition of a client-specified shell ID. |
WSManDeinitialize Deinitializes the Windows Remote Management client stack. |
WSManDisconnectShell Disconnects the network connection of an active shell and its associated commands. |
WSManGetErrorMessage Retrieves the error messages associated with a particular error and language codes. |
WSManGetSessionOptionAsDword Gets the value of a session option. (WSManGetSessionOptionAsDword) |
WSManGetSessionOptionAsString Gets the value of a session option. (WSManGetSessionOptionAsString) |
WSManInitialize Initializes the Windows Remote Management Client API. |
WSManPluginAuthzOperationComplete Reports either a successful or failed authorization for a user operation. |
WSManPluginAuthzQueryQuotaComplete Called from the WSManPluginAuthzQueryQuota plug-in entry point and must be called whether or not the plug-in can carry out the request. |
WSManPluginAuthzUserComplete Reports either a successful or failed user connection authorization. |
WSManPluginFreeRequestDetails Releases memory that is allocated for the WSMAN_PLUGIN_REQUEST structure, which is passed into operation plug-in entry points. |
WSManPluginGetOperationParameters Gets operational information for items such as time-outs and data restrictions that are associated with the operation. |
WSManPluginOperationComplete Reports the completion of an operation by all operation entry points except for the WSManPluginStartup and WSManPluginShutdown methods. |
WSManPluginReceiveResult Reports results for the WSMAN_PLUGIN_RECEIVE plug-in call and is used by most shell plug-ins that return results. |
WSManPluginReportContext Reports shell and command context back to the Windows Remote Management (WinRM) infrastructure so that further operations can be performed against the shell and/or command. |
WSManReceiveShellOutput Retrieves output from a running command or from the shell. |
WSManReconnectShell Reconnects a previously disconnected shell session. To reconnect the shell session's associated commands, use WSManReconnectShellCommand. |
WSManReconnectShellCommand Reconnects a previously disconnected command. |
WSManRunShellCommand Starts the execution of a command within an existing shell and does not wait for the completion of the command. |
WSManRunShellCommandEx Provides the same functionality as the WSManRunShellCommand function, with the addition of a command ID option. |
WSManSendShellInput Ipes the input stream to a running command or to the shell. |
WSManSetSessionOption Sets an extended set of options for the session. |
WSManSignalShell Sends a control code to an existing command or to the shell itself. |
Callback functions
WSMAN_PLUGIN_AUTHORIZE_OPERATION Authorizes a specific operation. |
WSMAN_PLUGIN_AUTHORIZE_QUERY_QUOTA Retrieves quota information for the user after a connection has been authorized. |
WSMAN_PLUGIN_AUTHORIZE_RELEASE_CONTEXT Releases the context that a plug-in reports from either WSManPluginAuthzUserComplete or WSManPluginAuthzOperationComplete. |
WSMAN_PLUGIN_AUTHORIZE_USER Authorizes a connection. |
WSMAN_PLUGIN_COMMAND Defines the command callback for a plug-in. |
WSMAN_PLUGIN_CONNECT Defines the connect callback for a plug-in. |
WSMAN_PLUGIN_RECEIVE Defines the receive callback for a plug-in. |
WSMAN_PLUGIN_RELEASE_COMMAND_CONTEXT Defines the release command callback for the plug-in. |
WSMAN_PLUGIN_RELEASE_SHELL_CONTEXT Defines the release shell callback for the plug-in. |
WSMAN_PLUGIN_SEND Defines the send callback for a plug-in. |
WSMAN_PLUGIN_SHELL Defines the shell callback for a plug-in. |
WSMAN_PLUGIN_SHUTDOWN Defines the shutdown callback for the plug-in. |
WSMAN_PLUGIN_SIGNAL Defines the signal callback for a plug-in. |
WSMAN_PLUGIN_STARTUP Defines the startup callback for the plug-in. |
WSMAN_SHELL_COMPLETION_FUNCTION The callback function that is called for shell operations, which result in a remote request. |
Structures
WSMAN_AUTHENTICATION_CREDENTIALS Defines the authentication method and the credentials used for server or proxy authentication. |
WSMAN_AUTHZ_QUOTA Reports quota information on a per-user basis for authorization plug-ins. |
WSMAN_CERTIFICATE_DETAILS Stores client information for an inbound request that was sent with a client certificate. |
WSMAN_COMMAND_ARG_SET Represents the set of arguments that are passed in to the command line. |
WSMAN_DATA Contains inbound and outbound data used in the Windows Remote Management (WinRM) API. |
WSMAN_DATA_BINARY Holds binary data for use with various Windows Remote Management functions. |
WSMAN_DATA_TEXT Holds textual data for use with various Windows Remote Management functions. |
WSMAN_ENVIRONMENT_VARIABLE Defines an individual environment variable by using a name and value pair. |
WSMAN_ENVIRONMENT_VARIABLE_SET Defines an array of environment variables. |
WSMAN_ERROR Contains error information that is returned by a Windows Remote Management (WinRM) client. |
WSMAN_FILTER WSMAN_FILTER is reserved for future use. |
WSMAN_FRAGMENT WSMAN_FRAGMENT is reserved for future use. |
WSMAN_KEY Represents a key and value pair within a selector set and is used to identify a particular resource. |
WSMAN_OPERATION_INFO Represents a specific resource endpoint for which the plug-in must perform the request. |
WSMAN_OPTION Represents a specific option name and value pair. |
WSMAN_OPTION_SET Represents a set of options. |
WSMAN_PLUGIN_REQUEST Specifies information for a plug-in request. |
WSMAN_PROXY_INFO Specifies proxy information. |
WSMAN_RECEIVE_DATA_RESULT Represents the output data received from a WSManReceiveShellOutput method. |
WSMAN_RESPONSE_DATA Represents the output data received from a WSMan operation. |
WSMAN_SELECTOR_SET Defines a set of keys that represent the identity of a resource. |
WSMAN_SENDER_DETAILS Specifies the client details for every inbound request. |
WSMAN_SHELL_ASYNC Defines an asynchronous structure to be passed to all shell operations. |
WSMAN_SHELL_DISCONNECT_INFO Specifies the maximum duration, in milliseconds, the shell will stay open after the client has disconnected. |
WSMAN_SHELL_STARTUP_INFO_V10 The WSMAN_SHELL_STARTUP_INFO_V10 (wsman.h) structure defines the shell startup parameters to be used with the WSManCreateShell function. |
WSMAN_SHELL_STARTUP_INFO_V11 The WSMAN_SHELL_STARTUP_INFO_V11 (wsman.h) structure defines the shell startup parameters to be used with the WSManCreateShell function. |
WSMAN_STREAM_ID_SET Lists all the streams that are used for either input or output for the shell and commands. |
WSMAN_USERNAME_PASSWORD_CREDS Defines the credentials used for authentication. |
Enumerations
WSManAuthenticationFlags Determines the authentication method for the operation. |
WSManCallbackFlags Defines a set of flags used by all callback functions. |
WSManDataType Specifies the current data type of the union in the WSMAN_DATA structure. |
WSManProxyAccessType Defines the proxy access type. |
WSManSessionOption Defines a set of extended options for the session. These options are used with the WSManSetSessionOption method. |