Module netapp_ontap.resources.xc_cluster

Copyright © 2022 NetApp Inc. All rights reserved.

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

Classes

class XcCluster (*args, **kwargs)

Cluster clone for cross_cluster.

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

Methods

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

Cross cluster GET cluster


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

Inherited members

class XcClusterSchema (*, 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 XcCluster object

Ancestors

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

Class variables

certificate: SecurityCertificate GET PATCH

The certificate field of the xc_cluster.

configuration_backup: ConfigurationBackup POST

The configuration_backup field of the xc_cluster.

contact: str GET POST PATCH

The contact field of the xc_cluster.

Example: support@company.com

dns_domains: List[str] GET POST PATCH

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".
  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.
  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.
  • The top level domain must contain only the following characters: A through Z, a through z.
  • The system reserves the following names:"all", "local", and "localhost".

Example: ["example.com","example2.example3.com"]

license: LicenseKeys POST

The license field of the xc_cluster.

The links field of the xc_cluster.

location: str GET POST PATCH

The location field of the xc_cluster.

Example: building 1

management_interface: ClusterManagementInterface POST

The management_interface field of the xc_cluster.

management_interfaces: List[NetworkRouteInterfaces] GET

The management_interfaces field of the xc_cluster.

metric: PerformanceMetric GET

The metric field of the xc_cluster.

name: str GET POST PATCH

The name field of the xc_cluster.

Example: cluster1

name_servers: List[str] GET POST PATCH

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

Example: ["10.224.65.20","2001:db08:a0b:12f0::1"]

nodes: List[Node] POST

The nodes field of the xc_cluster.

ntp_servers: List[str] GET POST

Host name, IPv4 address, or IPv6 address for the external NTP time servers.

Example: ["time.nist.gov","10.98.19.20","2610:20:6F15:15::27"]

password: str POST

Initial admin password used to create the cluster.

Example: mypassword

peering_policy: ClusterPeeringPolicy GET POST PATCH

The peering_policy field of the xc_cluster.

san_optimized: bool GET

Specifies if this cluster is an All SAN Array.

statistics: PerformanceMetricRaw GET

The statistics field of the xc_cluster.

timezone: TimezoneCluster GET POST PATCH

The timezone field of the xc_cluster.

uuid: str GET

The uuid field of the xc_cluster.

Example: 1cd8a442-86d1-11e0-ae1c-123478563412

version: Version GET

The version field of the xc_cluster.