Module netapp_ontap.resources.xc_node

Copyright © 2022 NetApp Inc. All rights reserved.

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

Classes

class XcNode (*args, **kwargs)

Node 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

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 find(*args, connection: HostConnection = None, **kwargs) -> Resource

Cross cluster GET cluster


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]

Cross cluster GET cluster


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.

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 XcNodeSchema (*, 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 XcNode object

Ancestors

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

Class variables

cluster_interface: ClusterNodesClusterInterface POST

The cluster_interface field of the xc_node.

cluster_interfaces: List[XcClusterNodesManagementInterfaces] GET

The cluster_interfaces field of the xc_node.

controller: ClusterNodesController GET POST PATCH

The controller field of the xc_node.

date: ImpreciseDateTime GET

The current or "wall clock" time of the node in ISO-8601 date, time, and time zone format. The ISO-8601 date and time are localized based on the ONTAP cluster's timezone setting.

Example: 2019-04-17T11:49:26-04:00

external_cache: ClusterNodesExternalCache GET

The external_cache field of the xc_node.

ha: XcNodeHa GET POST PATCH

The ha field of the xc_node.

hw_assist: HwAssist GET

The hw_assist field of the xc_node.

is_all_flash_optimized: bool GET

Specifies whether the node is all flash optimized.

is_all_flash_select_optimized: bool GET

Specifies whether the node is all flash select optimized.

is_capacity_optimized: bool GET

Specifies whether the node is capacity optimized.

is_performance_optimized: bool GET

Specifies whether the node is performance optimized.

is_spares_low: bool GET

Specifies whether or not the node is in spares low condition.

The links field of the xc_node.

location: str GET POST PATCH

The location field of the xc_node.

Example: rack 2 row 5

management_interface: ClusterNodesManagementInterface POST

The management_interface field of the xc_node.

management_interfaces: List[XcClusterNodesManagementInterfaces] GET

The management_interfaces field of the xc_node.

membership: str GET

Possible values:

  • available - A node is detected on the internal cluster network and can be added to the cluster. Nodes that have a membership of "available" are not returned when a GET request is called when the cluster exists. Provide a query on the "membership" property for available to scan for nodes on the cluster network. Nodes that have a membership of "available" are returned automatically before a cluster is created.
  • joining - Joining nodes are in the process of being added to the cluster. The node might be progressing through the steps to become a member or might have failed. The job to add the node or create the cluster provides details on the current progress of the node.
  • member - Nodes that are members have successfully joined the cluster.

Valid choices:

  • available
  • joining
  • member
metric: NodeMetrics GET

The metric field of the xc_node.

metrocluster: ClusterNodesMetrocluster GET POST PATCH

The metrocluster field of the xc_node.

model: str GET

The model field of the xc_node.

Example: FAS3070

name: str GET POST PATCH

The name field of the xc_node.

Example: node-01

nvram: ClusterNodesNvram GET POST PATCH

The nvram field of the xc_node.

owner: str GET POST PATCH

Owner of the node.

Example: Example Corp

serial_number: str GET

The serial_number field of the xc_node.

Example: 4048820-60-9

service_processor: ServiceProcessor GET POST PATCH

The service_processor field of the xc_node.

state: str GET

State of the node:

  • up - Node is up and operational.
  • booting - Node is booting up.
  • down - Node has stopped or is dumping core.
  • taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback.
  • waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks.
  • degraded - Node has one or more critical services offline.
  • unknown - Node or its HA partner cannot be contacted and there is no information on the node's state.

Valid choices:

  • up
  • booting
  • down
  • taken_over
  • waiting_for_giveback
  • degraded
  • unknown
statistics: NodeStatistics GET

The statistics field of the xc_node.

storage_configuration: str GET

The storage configuration in the system. Possible values:

  • mixed_path
  • single_path
  • multi_path
  • quad_path
  • mixed_path_ha
  • single_path_ha
  • multi_path_ha
  • quad_path_ha
  • unknown

Valid choices:

  • unknown
  • single_path
  • multi_path
  • mixed_path
  • quad_path
  • single_path_ha
  • multi_path_ha
  • mixed_path_ha
  • quad_path_ha
system_id: str GET

The system_id field of the xc_node.

Example: 0537035403

system_machine_type: str GET

OEM system machine type.

Example: 7Y56-CTOWW1

uptime: Size GET

The total time, in seconds, that the node has been up.

Example: 300536

uuid: str GET

The uuid field of the xc_node.

Example: 4ea7a442-86d1-11e0-ae1c-123478563412

vendor_serial_number: str GET

OEM vendor serial number.

Example: 791603000068

version: Version GET

The version field of the xc_node.

vm: ClusterNodesVm GET POST PATCH

The vm field of the xc_node.