REST API for Oracle SD-WAN Edge Release 9.1.1

Save TACACS settings

post

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/saveTacacsSettings

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the tacacs info

Root Schema : schema

Type: object

Show Source

tacacs_auth_type: string

Example: ASCII
tacacs_confirm_key: string

Example: 1123
tacacs_enabled: string

Example: true
tacacs_port: string

Example: 10.1.2.74
tacacs_port2: string

Example: 49
tacacs_port3: string

Example: 42
tacacs_server_ip_addr: string

Example: 10.1.2.73
tacacs_server_ip_addr2: string

Example: 10.1.2.75
tacacs_server_ip_addr3: string

Example: 10.1.2.75
tacacs_server_key: string

Example: 1123
tacacs_timeout: string

Example: 42
timestamp: string

Example: MTYyNTUxNTc3Mg==

{
    "type":"object",
    "properties":{
        "tacacs_enabled":{
            "type":"string",
            "example":true
        },
        "tacacs_server_ip_addr":{
            "type":"string",
            "example":"10.1.2.73"
        },
        "tacacs_port":{
            "type":"string",
            "example":"10.1.2.74"
        },
        "tacacs_server_ip_addr2":{
            "type":"string",
            "example":"10.1.2.75"
        },
        "tacacs_port2":{
            "type":"string",
            "example":"49"
        },
        "tacacs_server_ip_addr3":{
            "type":"string",
            "example":"10.1.2.75"
        },
        "tacacs_port3":{
            "type":"string",
            "example":"42"
        },
        "tacacs_server_key":{
            "type":"string",
            "example":"1123"
        },
        "tacacs_confirm_key":{
            "type":"string",
            "example":"1123"
        },
        "tacacs_auth_type":{
            "type":"string",
            "example":"ASCII"
        },
        "tacacs_timeout":{
            "type":"string",
            "example":"42"
        },
        "timestamp":{
            "type":"string",
            "example":"MTYyNTUxNTc3Mg=="
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a POST"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to save TACACS settings by submitting a POST request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/users_Auth/saveTacacsSettings"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "tacacs_auth_type": "ASCII",
  "tacacs_confirm_key": "1123",
  "tacacs_enabled":"on",
  "tacacs_port": 49,
  "tacacs_port2": 48,
  "tacacs_port3": 47,
  "tacacs_server_ip_addr": "100.9.9.9",
  "tacacs_server_ip_addr2": "100.8.8.8",
  "tacacs_server_ip_addr3": "100.8.8.7",
  "tacacs_server_key": "1123",
  "tacacs_timeout": 3,
  "timestamp":<timestamp>
}

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": "TACACS+ settings successfully saved.",
  "status": "success"
}