# salt.modules.win_status

Module for returning various status data about a minion. These data can be useful for compiling into stats later, or for problem-solving if your minion is having problems.

Added in version 0.12.0.

depends:

  - wmi

class salt.modules.win_status.SYSTEM_PERFORMANCE_INFORMATION
  AvailablePagedPoolPages

    Structure/Union member

  AvailablePages

    Structure/Union member

  CacheIoCount

    Structure/Union member

  CacheReadCount

    Structure/Union member

  CacheTransitionCount

    Structure/Union member

  CcCopyReadNoWait

    Structure/Union member

  CcCopyReadNoWaitMiss

    Structure/Union member

  CcCopyReadWait

    Structure/Union member

  CcCopyReadWaitMiss

    Structure/Union member

  CcDataFlushes

    Structure/Union member

  CcDataPages

    Structure/Union member

  CcDirtyPagesThreshold

    Structure/Union member

  CcFastMdlReadNoWait

    Structure/Union member

  CcFastMdlReadNotPossible

    Structure/Union member

  CcFastMdlReadResourceMiss

    Structure/Union member

  CcFastMdlReadWait

    Structure/Union member

  CcFastReadNoWait

    Structure/Union member

  CcFastReadNotPossible

    Structure/Union member

  CcFastReadResourceMiss

    Structure/Union member

  CcFastReadWait

    Structure/Union member

  CcLazyWriteIos

    Structure/Union member

  CcLazyWritePages

    Structure/Union member

  CcMapDataNoWait

    Structure/Union member

  CcMapDataNoWaitMiss

    Structure/Union member

  CcMapDataWait

    Structure/Union member

  CcMapDataWaitMiss

    Structure/Union member

  CcMdlReadNoWait

    Structure/Union member

  CcMdlReadNoWaitMiss

    Structure/Union member

  CcMdlReadWait

    Structure/Union member

  CcMdlReadWaitMiss

    Structure/Union member

  CcPinMappedDataCount

    Structure/Union member

  CcPinReadNoWait

    Structure/Union member

  CcPinReadNoWaitMiss

    Structure/Union member

  CcPinReadWait

    Structure/Union member

  CcPinReadWaitMiss

    Structure/Union member

  CcReadAheadIos

    Structure/Union member

  CcTotalDirtyPages

    Structure/Union member

  CommitLimit

    Structure/Union member

  CommittedPages

    Structure/Union member

  ContextSwitches

    Structure/Union member

  CopyOnWriteCount

    Structure/Union member

  DemandZeroCount

    Structure/Union member

  DirtyPagesWriteCount

    Structure/Union member

  DirtyWriteIoCount

    Structure/Union member

  FirstLevelTbFills

    Structure/Union member

  FreeSystemPtes

    Structure/Union member

  IdleProcessTime

    Structure/Union member

  IoOtherOperationCount

    Structure/Union member

  IoOtherTransferCount

    Structure/Union member

  IoReadOperationCount

    Structure/Union member

  IoReadTransferCount

    Structure/Union member

  IoWriteOperationCount

    Structure/Union member

  IoWriteTransferCount

    Structure/Union member

  MappedPagesWriteCount

    Structure/Union member

  MappedWriteIoCount

    Structure/Union member

  NonPagedPoolAllocs

    Structure/Union member

  NonPagedPoolFrees

    Structure/Union member

  NonPagedPoolLookasideHits

    Structure/Union member

  NonPagedPoolPages

    Structure/Union member

  PageFaultCount

    Structure/Union member

  PageReadCount

    Structure/Union member

  PageReadIoCount

    Structure/Union member

  PagedPoolAllocs

    Structure/Union member

  PagedPoolFrees

    Structure/Union member

  PagedPoolLookasideHits

    Structure/Union member

  PagedPoolPages

    Structure/Union member

  PeakCommitment

    Structure/Union member

  ResidentAvailablePages

    Structure/Union member

  ResidentPagedPoolPage

    Structure/Union member

  ResidentSystemCachePage

    Structure/Union member

  ResidentSystemCodePage

    Structure/Union member

  ResidentSystemDriverPage

    Structure/Union member

  SecondLevelTbFills

    Structure/Union member

  SharedCommittedPages

    Structure/Union member

  SystemCalls

    Structure/Union member

  TotalSystemCodePages

    Structure/Union member

  TotalSystemDriverPages

    Structure/Union member

  TransitionCount

    Structure/Union member

salt.modules.win_status.cpuload()

  Added in version 2015.8.0.

  Return the processor load as a percentage.

  CLI Example:

      salt '*' status.cpuload

salt.modules.win_status.cpustats()

  Return information about the CPU.

  Returns

    dict: A dictionary containing information about the CPU stats.

  CLI Example:

      salt * status.cpustats

salt.modules.win_status.diskusage(human_readable=False, path=None)

  Added in version 2015.8.0.

  Return the disk usage for this minion.

  Parameters:

    - human_readable (`bool`, optional) --

      If `True`, usage will be in KB/MB/GB etc.

      Default is `False`.

    - path (`str`, optional) --

      The path to the disk. Usually a drive letter such as `C:\`.

      Default is `None`.

  CLI Example:

      salt '*' status.diskusage path=c:/salt

salt.modules.win_status.loadavg()

  Returns counter information related to the load of the machine.

  Returns:

    A dictionary of counters.

  Return type:

    dict

  CLI Example:

      salt * status.loadavg

salt.modules.win_status.master(master=None, connected=True)

  Added in version 2015.5.0.

  Fire an event if the minion gets disconnected from its master. This function is meant to be run via a scheduled job from the minion. If master_ip is an FQDN/Hostname, is must be resolvable to a valid IPv4 address.

  Parameters:

    - master (`str`, optional) --

      The master address, FQDN, or hostname to connect to.

      Default is `None`.

    - connected (`bool`, optional) --

      If `True`, fire an event if the master is connected, otherwise fire an event if the master is disconnected.

      Default is `True`.

  CLI Example:

      salt '*' status.master

salt.modules.win_status.meminfo()

  Return information about physical and virtual memory on the system.

  Returns:

    A dictionary of information about memory on the system.

  Return type:

    dict

  CLI Example:

      salt * status.meminfo

salt.modules.win_status.procs(count=False)

  Return the process data.

  Parameters:

    count (`bool`, optional) --

    If `True`, this function will simply return the number of processes.

    Added in version 2015.8.0.

    Default is `False`.

  CLI Example:

      salt '*' status.procs
      salt '*' status.procs count

salt.modules.win_status.saltmem(human_readable=False)

  Added in version 2015.8.0.

  Returns the amount of memory that salt is using.

  Parameters:

    human_readable (`bool`, optional) --

    Return the value in a nicely formatted number.

    Default is `False`.

  CLI Example:

      salt '*' status.saltmem
      salt '*' status.saltmem human_readable=True

salt.modules.win_status.uptime(human_readable=False)

  Added in version 2015.8.0.

  Return the system uptime for the machine.

  Parameters:

    human_readable (`bool`, optional) --

    If `True`, return uptime in human-readable format, otherwise return seconds.

    Default is `False`.

    Note

    Human readable format is `days, hours:min:sec`. Days will only be displayed if more than 0

  Returns:

    The uptime in seconds or human-readable format depending on the

      value of `human_readable`

  Return type:

    str

  CLI Example:

      salt '*' status.uptime
      salt '*' status.uptime human_readable=True

salt.modules.win_status.vmstats()

  Return information about the virtual memory on the machine.

  Returns:

    A dictionary of virtual memory stats.

  Return type:

    dict

  CLI Example:

      salt * status.vmstats