# Module `netapp_ontap.resources.security_certificate_authority`

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

This API displays security certificate information and manages the local certificate authorities in ONTAP.

# TODO: Add examples

## Classes

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

  Allows interaction with SecurityCertificateAuthority 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

  ### Static methods

  `def count_collection(*args, connection: HostConnection = None, **kwargs) -> int`

    Fetch a count of all objects of this type from the host.

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def delete_collection(*args, records: Iterable[_ForwardRef('SecurityCertificateAuthority')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes a local certificate authority from ONTAP.

    ### Related ONTAP commands

    - `security certificate authority delete`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Delete all objects in a collection which match the given query.

    All records on the host which match the query will be deleted.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
    `records`
      Can be provided in place of a query. If so, this list of objects will be deleted from the host.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

    ## Returns

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

    ## Raises

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

  `def find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves certificate authorities created in ONTAP.

    ### Related ONTAP commands

    - `security certificate authority show`
    - `security certificate authority show-issued`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]`

    Retrieves certificate authorities created in ONTAP.

    ### Related ONTAP commands

    - `security certificate authority show`
    - `security certificate authority show-issued`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Fetch a list of all objects of this type from the host.

    This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def post_collection(records: Iterable[_ForwardRef('SecurityCertificateAuthority')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[SecurityCertificateAuthority], NetAppResponse]`

    Creates a certificate authority in ONTAP and installs its public certificate in truststore.

    ### Required properties

    - `svm.uuid` or `svm.name` - Existing SVM in which to create or install the certificate.

    ### Recommended optional properties

    - `cert-name` - Unique name to identify the certificate within the SVM.
    - `subject_name` - Subject details of the certificate.
    - `expiry_time` - Certificate expiration time. Specifying an expiration time is recommended when creating a certificate authority.
    - `security_strength` - Key size of the certificate, in bits Specifying a stronger security strength in bits is recommended when creating a certificate authority.
    - `algorithm` - Asymmetric algorithm. Algroithm to use to generate public/private key pair when creating a certificate authority.
    - `key_password` - Password for encrypting the private key when creating a self signed certificatea authority.
    - `hash_function` - Hashing function. Can be provided on POST when creating a self-signed certificate authority.
    - `rfc822_name` - Email address for the subject alternate name extension.
    - `uri` - URI for the subject alternate name extension.
    - `dns_name` - DNS name for the subject alternate name extension.
    - `ipaddr` - IP address for the subject alternate name extension.

    ### Default property values

    If not specified in POST, the following default property values are assigned: * `security_strength` - 112 * `expiry_time` - P365DT * `hash_function` - sha256

    ### Related ONTAP commands

    - `security certificate authority create`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Send this collection of objects to the host as a creation request.

    ## Args

    `records`
      A list of `Resource` objects to send to the server to be created.
    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

    ## Returns

    A list of `Resource` objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a `NetAppResponse` object is returned instead.

    ## Raises

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

  ### Methods

  `def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Deletes a local certificate authority from ONTAP.

    ### Related ONTAP commands

    - `security certificate authority delete`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Send a deletion request to the host for this object.

    ## Args

    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

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

    ## Raises

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

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

    Retrieves a local certificate authority from ONTAP.

    ### Related ONTAP commands

    - `security certificate authority show`
    - `security certificate authority show-issued`

    ### Learn more

    - `DOC /security/certificate-authorities`

    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 post(self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Creates a certificate authority in ONTAP and installs its public certificate in truststore.

    ### Required properties

    - `svm.uuid` or `svm.name` - Existing SVM in which to create or install the certificate.

    ### Recommended optional properties

    - `cert-name` - Unique name to identify the certificate within the SVM.
    - `subject_name` - Subject details of the certificate.
    - `expiry_time` - Certificate expiration time. Specifying an expiration time is recommended when creating a certificate authority.
    - `security_strength` - Key size of the certificate, in bits Specifying a stronger security strength in bits is recommended when creating a certificate authority.
    - `algorithm` - Asymmetric algorithm. Algroithm to use to generate public/private key pair when creating a certificate authority.
    - `key_password` - Password for encrypting the private key when creating a self signed certificatea authority.
    - `hash_function` - Hashing function. Can be provided on POST when creating a self-signed certificate authority.
    - `rfc822_name` - Email address for the subject alternate name extension.
    - `uri` - URI for the subject alternate name extension.
    - `dns_name` - DNS name for the subject alternate name extension.
    - `ipaddr` - IP address for the subject alternate name extension.

    ### Default property values

    If not specified in POST, the following default property values are assigned: * `security_strength` - 112 * `expiry_time` - P365DT * `hash_function` - sha256

    ### Related ONTAP commands

    - `security certificate authority create`

    ### Learn more

    - `DOC /security/certificate-authorities`

    Send this object to the host as a creation request.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## Returns

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

    ## Raises

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

  `def sign(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Signs a certificate.

    ### Required properties

    - `signing_request` - Certificate signing request to be signed by the given certificate authority.

    ### Recommended optional properties

    - `expiry_time` - Certificate expiration time. Specifying an expiration time for a signed certificate is recommended.
    - `hash_function` - Hashing function. Specifying a strong hashing function is recommended when signing a certificate.

    ### Default property values

    If not specified in POST, the following default property values are assigned: * `expiry_time` - P300DT * `hash_function` - sha256

    ### Related ONTAP commands

    - `security certificate authority sign` This API is used to sign a certificate request using an existing local certificate authority. The local certificate authority maintains the records of its signed certificates.
      The root certificate can be created for a given SVM or for the cluster using [`POST security/certificate-authorities`].

    Perform a custom action on this resource which is not a simple CRUD action

    ## Args

    `path`
      The action verb for this request. This will be added as a postfix to the instance location of the resource.
    `body`
      The body of the action request. This should be a Resource instance. The connection and URL will be determined based on the values from this object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

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

    ## Raises

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

  ### Inherited members

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

  The fields of the SecurityCertificateAuthority object

  ### Ancestors

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

  ### Class variables

  `algorithm: str GET POST`

    Asymmetric Encryption Algorithm.

    Valid choices:

    - rsa
    - ec
  `expiry_time: ImpreciseDateTime GET POST`

    Certificate expiration time. Can be provided on POST if creating a self-signed certificate. Default value is 300 days from the current date.

    Example: 2021-06-04T19:00:00Z

  `hash_function: str GET POST`

    Hashing function. Can be provided on POST when creating a self-signed certificate. Hash function sha1 is not allowed on POST.

    Valid choices:

    - sha1
    - sha256
    - sha224
    - sha384
    - sha512
  `key_usage: str GET POST`

    Key usage extensions.

    Valid choices:

    - digitalsignature
    - nonrepudiation
    - keyencipherment
    - dataencipherment
    - keyagreement
    - keycertsign
    - crlsign
    - encipheronly
    - decipheronly
    - critical
  `links: SelfLink GET`

    The links field of the security_certificate_authority.

  `name: str GET POST`

    Certificate name. If not provided in POST, a unique name specific to the SVM is automatically generated.

    Example: cert1

  `public_certificate: str GET`

    Public key certificate, in PEM format. If this is not provided in POST, a self-signed certificate is created.

    Example: -----BEGIN CERTIFICATE----- MIIBuzCCAWWgAwIBAgIIFTZBrqZwUUMwDQYJKoZIhvcNAQELBQAwHDENMAsGA1UE AxMEVEVTVDELMAkGA1UEBhMCVVMwHhcNMTgwNjA4MTgwOTAxWhcNMTkwNjA4MTgw OTAxWjAcMQ0wCwYDVQQDEwRURVNUMQswCQYDVQQGEwJVUzBcMA0GCSqGSIb3DQEB AQUAA0sAMEgCQQDaPvbqUJJFJ6NNTyK3Yb+ytSjJ9aa3yUmYTD9uMiP+6ycjxHWB e8u9z6yCHsW03ync+dnhE5c5z8wuDAY0fv15AgMBAAGjgYowgYcwDAYDVR0TBAUw AwEB/zALBgNVHQ8EBAMCAQYwHQYDVR0OBBYEFMJ7Ev/o/3+YNzYh5XNlqqjnw4zm MEsGA1UdIwREMEKAFMJ7Ev/o/3+YNzYh5XNlqqjnw4zmoSCkHjAcMQ0wCwYDVQQD EwRURVNUMQswCQYDVQQGEwJVU4IIFTZBrqZwUUMwDQYJKoZIhvcNAQELBQADQQAv DovYeyGNnknjGI+TVNX6nDbyzf7zUPqnri0KuvObEeybrbPW45sgsnT5dyeE/32U 9Yr6lklnkBtVBDTmLnrC -----END CERTIFICATE-----

  `scope: str GET`

    Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

    Valid choices:

    - svm
    - cluster
  `security_strength: Size GET POST`

    Security strength of the certificate, in bits. Can be provided on POST if creating a self-signed certificate.

  `serial_number: str GET`

    Serial number of certificate.

  `start_time: ImpreciseDateTime GET POST`

    Certificate validity start time. Can be provided on POST if creating a self-signed certificate. Default value is current time.

    Example: 2020-06-04T19:00:00Z

  `subject_alternatives: SubjectAlternateName GET`

    The subject_alternatives field of the security_certificate_authority.

  `subject_name: str GET POST`

    Subject name details of the certificate. Provide on POST when creating a self-signed certificate. The format is a list of comma seperated key=value pairs.

    Example: C=US,S=NC,O=NTAP,CN=test.domain.com

  `svm: Svm GET POST`

    The svm field of the security_certificate_authority.

  `uuid: str GET`

    Unique ID that identifies a certificate.