Windows Server Windows Server: Inputs & Outputs

Summary

Each plugin uses a set of dictionaries to store data.

These are used by plugin actions as both inputs and outputs.

This page will cover:

  • The dictionaries used in this plugin
  • The information each dictionary contains

Info

See Commands & Files for each action's inputs & outputs.

Dictionary Types

RDPSession

  • Contains RDP session details

  • The example below shows the dictionary structure in YAML

Example

1
2
3
4
5
rdp_session:
  username: domain\username
  session_name: rdp-tcp#50
  state: Active
  id: 2
All RDPSession Keys

id: The RDP session ID on the Windows Server.

username: The username the RDP session was authenticated with.

session_name: The name of the RDP session.

state: The state of the RDP session (Disconnected, Connected, Active, Listening).

Service

  • Contains Windows service details

  • The example below shows the dictionary structure in YAML

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
name: Dhcp
display_name: DHCP Client
state: Running
status: OK
start_name: NT Authority\\LocalService
description: >
  Registers and updates IP addresses and DNS records for this computer.
  If this service is stopped, this computer will not receive dynamic IP addresses
  and DNS updates. If this service is disabled, any services that explicitly depend
  on it will fail to start.
All Service Keys

name: The name of the service.

display_name: The display name for the service.

state: The state of the service.

status: The service status.

start_name: The account the service runs under.

description: The service description.

WindowsServer

  • Contains remote Powershell connection details for a Windows Server

  • It is used as an input to many of the actions in this plugin

  • The example below shows the dictionary structure in YAML

  • See the required and optional keys underneath the example

Supplying Credentials

You should always use a PPA Vault integration to provide credentials to a plugin action.

Example

1
2
3
4
5
6
windows_server:
  address: windows-server.internal.net
  username: example.username
  password: example.password
  validate_cert: true
  use_ssl: true

Required Keys

address: The target IP or DNS address.

username: Username for authentication.

password: Password for authentication.

Optional Keys

validate_cert: Set to false to skip certificate validation (defaults to true).

use_ssl: Set to false to connect over HTTP (defaults to true using HTTPS).