# salt.states.cimc

A state module to manage Cisco UCS chassis devices.

codeauthor:

  `Spencer Ervin <spencer_ervin@hotmail.com>`

maturity:

  new

depends:

  none

platform:

  unix

## About

This state module was designed to handle connections to a Cisco Unified Computing System (UCS) chassis. This module relies on the CIMC proxy module to interface with the device.

See also

`CIMC Proxy Module`

salt.states.cimc.hostname(name, hostname=None)

  Ensures that the hostname is set to the specified value.

  Added in version 2019.2.0.

  name: The name of the module function to execute.

  hostname(str): The hostname of the server.

  SLS Example:

      set_name:
        cimc.hostname:
          - hostname: foobar

salt.states.cimc.logging_levels(name, remote=None, local=None)

  Ensures that the logging levels are set on the device. The logging levels must match the following options: emergency, alert, critical, error, warning, notice, informational, debug.

  Added in version 2019.2.0.

  name: The name of the module function to execute.

  remote(str): The logging level for SYSLOG logs.

  local(str): The logging level for the local device.

  SLS Example:

      logging_levels:
        cimc.logging_levels:
          - remote: informational
          - local: notice

salt.states.cimc.ntp(name, servers)

  Ensures that the NTP servers are configured. Servers are provided as an individual string or list format. Only four NTP servers will be reviewed. Any entries past four will be ignored.

  name: The name of the module function to execute.

  servers(str, list): The IP address or FQDN of the NTP servers.

  SLS Example:

      ntp_configuration_list:
        cimc.ntp:
          - servers:
            - foo.bar.com
            - 10.10.10.10

      ntp_configuration_str:
        cimc.ntp:
          - servers: foo.bar.com

salt.states.cimc.power_configuration(name, policy=None, delayType=None, delayValue=None)

  Ensures that the power configuration is configured on the system. This is only available on some C-Series servers.

  Added in version 2019.2.0.

  name: The name of the module function to execute.

  policy(str): The action to be taken when chassis power is restored after an unexpected power loss. This can be one of the following:

  > reset: The server is allowed to boot up normally when power is restored. The server can restart immediately or, optionally, after a fixed or random delay.

  > stay-off: The server remains off until it is manually restarted.

  > last-state: The server restarts and the system attempts to restore any processes that were running before power was lost.

  delayType(str): If the selected policy is reset, the restart can be delayed with this option. This can be one of the following:

  > fixed: The server restarts after a fixed delay.

  > random: The server restarts after a random delay.

  delayValue(int): If a fixed delay is selected, once chassis power is restored and the Cisco IMC has finished rebooting, the system waits for the specified number of seconds before restarting the server. Enter an integer between 0 and 240.

  SLS Example:

      reset_power:
        cimc.power_configuration:
          - policy: reset
          - delayType: fixed
          - delayValue: 0

      power_off:
        cimc.power_configuration:
          - policy: stay-off

salt.states.cimc.syslog(name, primary=None, secondary=None)

  Ensures that the syslog servers are set to the specified values. A value of None will be ignored.

  name: The name of the module function to execute.

  primary(str): The IP address or FQDN of the primary syslog server.

  secondary(str): The IP address or FQDN of the secondary syslog server.

  SLS Example:

      syslog_configuration:
        cimc.syslog:
          - primary: 10.10.10.10
          - secondary: foo.bar.com

salt.states.cimc.user(name, id='', user='', priv='', password='', status='active')

  Ensures that a user is configured on the device. Due to being unable to verify the user password. This is a forced operation.

  Added in version 2019.2.0.

  name: The name of the module function to execute.

  id(int): The user ID slot on the device.

  user(str): The username of the user.

  priv(str): The privilege level of the user.

  password(str): The password of the user.

  status(str): The status of the user. Can be either active or inactive.

  SLS Example:

      user_configuration:
        cimc.user:
          - id: 11
          - user: foo
          - priv: admin
          - password: mypassword
          - status: active