# Module `netapp_ontap.resources.security_config`

Copyright © 2020 NetApp Inc. All rights reserved.

## Overview

This API returns an object 'onboard_key_manager_configurable_status' which details whether the Onboard Key Manager can be configured on the cluster or not.

## Examples

### Retrieving information about the security configured on the cluster

The following example shows how to retrieve the key manager configiration of the cluster.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import SecurityConfig

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = SecurityConfig()
        resource.get(fields="*")
        print(resource)

Try it out

    SecurityConfig(
        {
            "onboard_key_manager_configurable_status": {
                "message": "Onboard Key Manager cannot be configured on the cluster. There are no self-encrypting disks in the cluster, and the following nodes do not support volume granular encryption: ntap-vsim2.",
                "code": 65537300,
                "supported": False,
            }
        }
    )

## ```

## Classes

`class SecurityConfig (*args, **kwargs)`

  Allows interaction with SecurityConfig objects on the host

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Methods

  `def get(self, **kwargs) -> NetAppResponse`

    Retrieves information about the security configured on the cluster.

    ### Learn more

    - `DOC /security`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def security_config_show(fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable`

    Fetch a single SecurityConfig resource

    Args:

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class SecurityConfigSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)`

  The fields of the SecurityConfig object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `links GET`

    The links field of the security_config.

  `onboard_key_manager_configurable_status GET POST PATCH`

    The onboard_key_manager_configurable_status field of the security_config.