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

Retrieve the CIFS domain-related information for an SVM

Contributors
PDFs

GET /protocols/cifs/domains/{svm.uuid}

Introduced In: 9.10

Retrieves the CIFS domain-related information of the specified SVM.

Important notes

GET operation with query parameter rediscover_trusts and reset_discovered_servers returns available CIFS domain configurations and also triggers trusts rediscovery and discovered servers reset asynchronously for that SVM.

  • 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 password schedule show

  • vserver cifs domain discovered-servers discovery-mode show

Learn more

Parameters

Name Type In Required Description

rediscover_trusts

boolean

query

False

Force the discovery of trusted domains.

  • Default value:

reset_discovered_servers

boolean

query

False

Force a rediscovery.

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.

server_discovery_mode

string

Specifies the mode of server discovery.

svm

svm

trust_relationships

array[trust_relationships]

Specifies the trusted domain records.
Example response 
{
  "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_day_of_week": "Sunday",
    "schedule_description": "string",
    "schedule_last_changed_time": "string",
    "schedule_time_of_day": 36900,
    "schedule_warn_message": "string"
  },
  "preferred_dcs": [
    {
      "fqdn": "test.com",
      "server_ip": "4.4.4.4",
      "status": {
        "details": "Response time (msec): 111",
        "reachable": 1
      }
    }
  ],
  "server_discovery_mode": "string",
  "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

ONTAP Error Response Codes

Error Code Description

656463

SVM UUID must be provided for a query on the field rediscover_trusts and reset_discovered_servers.
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

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_day_of_week

string

Day of the week for password change schedule.

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_time_of_day

string

Start time for password change schedule.

schedule_warn_message

string

Warning message in case job is deleted.

schedule_weekly_interval

integer

Interval in weeks for password change schedule.

status

Status of CIFS preferred domain controller.

Name Type Description

details

string

Provides a detailed description of the state if the state is 'down' or the response time of the DNS server if the state is 'up'.

reachable

boolean

Indicates whether or not the domain controller is reachable.

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.

status

status

Status of CIFS preferred domain controller.

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

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.