Skip to main content
A newer release of this product is available.

Retrieve the CIFS domain-related information of all SVMs

Contributors
PDFs

GET /protocols/cifs/domains

Introduced In: 9.10

Retrieves the CIFS domain-related information of all SVMs.

  • vserver cifs domain preferred-dc show

  • vserver cifs domain trusts show

  • vserver cifs domain discovered-servers show

  • vserver cifs domain name-mapping-search show

  • vserver cifs domain schedule show

Learn more

Parameters

Name Type In Required Description

name_mapping.trusted_domains

string

query

False

Filter by name_mapping.trusted_domains

trust_relationships.home_domain

string

query

False

Filter by trust_relationships.home_domain

trust_relationships.node.uuid

string

query

False

Filter by trust_relationships.node.uuid

trust_relationships.node.name

string

query

False

Filter by trust_relationships.node.name

trust_relationships.trusted_domains

string

query

False

Filter by trust_relationships.trusted_domains

preferred_dcs.fqdn

string

query

False

Filter by preferred_dcs.fqdn

preferred_dcs.server_ip

string

query

False

Filter by preferred_dcs.server_ip

discovered_servers.domain

string

query

False

Filter by discovered_servers.domain

discovered_servers.server_name

string

query

False

Filter by discovered_servers.server_name

discovered_servers.node.uuid

string

query

False

Filter by discovered_servers.node.uuid

discovered_servers.node.name

string

query

False

Filter by discovered_servers.node.name

discovered_servers.state

string

query

False

Filter by discovered_servers.state

discovered_servers.preference

string

query

False

Filter by discovered_servers.preference

discovered_servers.server_ip

string

query

False

Filter by discovered_servers.server_ip

discovered_servers.server_type

string

query

False

Filter by discovered_servers.server_type

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

password_schedule.schedule_description

string

query

False

Filter by password_schedule.schedule_description

password_schedule.schedule_enabled

boolean

query

False

Filter by password_schedule.schedule_enabled

password_schedule.schedule_last_changed_time

string

query

False

Filter by password_schedule.schedule_last_changed_time

password_schedule.schedule_randomized_minute

integer

query

False

Filter by password_schedule.schedule_randomized_minute

  • Max value: 180

  • Min value: 1

password_schedule.schedule_weekly_interval

integer

query

False

Filter by password_schedule.schedule_weekly_interval

  • Max value: 52

  • Min value: 1

password_schedule.schedule_warn_message

string

query

False

Filter by password_schedule.schedule_warn_message

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of CIFS domain records.

records

array[cifs_domain]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "discovered_servers": [
        {
          "domain": "test.com",
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "preference": "string",
          "server_ip": "string",
          "server_name": "string",
          "server_type": "string",
          "state": "string"
        }
      ],
      "name_mapping": {
        "trusted_domains": [
          "domain.com"
        ]
      },
      "password_schedule": {
        "schedule_description": "string",
        "schedule_last_changed_time": "string",
        "schedule_warn_message": "string"
      },
      "preferred_dcs": [
        {
          "fqdn": "test.com",
          "server_ip": "4.4.4.4"
        }
      ],
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "trust_relationships": [
        {
          "home_domain": "string",
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "trusted_domains": [
            "string"
          ]
        }
      ]
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

discovered_servers

Name Type Description

domain

string

Fully Qualified Domain Name.

node

node

preference

string

Server Preference

server_ip

string

Server IP address

server_name

string

Server Name

server_type

string

Server Type

state

string

Server status

name_mapping

Specifies the name mapping search records.

Name Type Description

trusted_domains

array[string]

password_schedule

Specifies the password schedule records.

Name Type Description

schedule_description

string

Schedule description.

schedule_enabled

boolean

Is password schedule enabled.

schedule_last_changed_time

string

Last successful password change time.

schedule_randomized_minute

integer

Minutes within which schedule start can be randomized.

schedule_warn_message

string

Warning message in case job is deleted.

schedule_weekly_interval

integer

Interval in weeks for password change schedule.

preferred_dcs

Name Type Description

fqdn

string

Fully Qualified Domain Name.

server_ip

string

IP address of the preferred domain controller (DC). The address can be either an IPv4 or an IPv6 address.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

trust_relationships

Name Type Description

home_domain

string

Home Domain Name

node

node

trusted_domains

array[string]

Trusted Domain Name

cifs_domain

Name Type Description

discovered_servers

array[discovered_servers]

Specifies the discovered servers records.

name_mapping

name_mapping

Specifies the name mapping search records.

password_schedule

password_schedule

Specifies the password schedule records.

preferred_dcs

array[preferred_dcs]

Specifies the preferred DC records.

svm

svm

trust_relationships

array[trust_relationships]

Specifies the trusted domain records.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.