Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

wisite_translationinternalip_binding

August 17, 2023
Contributed by: 
C

Binding object showing the translationinternalip that can be bound to wisite.

Properties

(click to see Operations )

Name Data Type Permissions Description
sitepath Read-write Path to the Web Interface site.

Minimum length = 1

Maximum length = 250
accesstype Read-write Type of access to the XenApp or XenDesktop server. Available settings function as follows
  • User Device - Clients can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server.
  • Gateway - Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server.
  • User Device and Gateway - Both clients and Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server. Default value: UserDevice Possible values = UserDevice, Gateway, UserDeviceAndGateway
    		•
    translationexternalport Read-write External port number associated with the server’s port number.

    Range 1 - 65535

    * in CLI is represented as 65535 in NITRO API
    translationinternalip Read-write IP address of the server for which you want to associate an external IP address. (Clients access the server through the associated external address and port.).

    Default value: 0
    translationexternalip Read-write External IP address associated with server’s IP address.
    translationinternalport Read-write Port number of the server for which you want to associate an external port. (Clients access the server through the associated external address and port.).

    Range 1 - 65535

    * in CLI is represented as 65535 in NITRO API
    __count Read-write count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • GET
    • GET (ALL)
    • COUNT

    Some options that you can use for each operations:

    • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

      http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

      If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

    • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

      To do this, you must specify the username and password in the request header of the NITRO request as follows:

      X-NITRO-USER: <username>

      X-NITRO-PASS: <password>

      Note: In such cases, make sure that the request header DOES not include the following:

      Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    *Note: *

    Mandatory parameters are marked in red and placeholder content is marked in green

    add

    URL: http:// <netscaler-ip-address /nitro/v1/config/wisite_translationinternalip_binding

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{
"wisite_translationinternalip_binding":{
<b>      "sitepath":<String_value>,
</b>      "translationinternalip":<String_value>,
      "translationinternalport":<Integer_value>,
      "translationexternalip":<String_value>,
      "translationexternalport":<Integer_value>,
      "accesstype":<String_value>
}}

<!--NeedCopy-->

    Response:

    HTTP Status Code on Success: 201 Created

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String>

    Query-parameters:

    args

    http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String> ? args=translationinternalip: <String_value> ,translationinternalport: <Integer_value> ,translationexternalip: <String_value> ,translationexternalport: <Integer_value>

    HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String>

    Query-parameters:

    filter

    http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

    Use this query-parameter to get the filtered set of wisite_translationinternalip_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    pagination

    http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String> ? pagesize=#no;pageno=#no

    Use this query-parameter to get the wisite_translationinternalip_binding resources in chunks.

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{  "wisite_translationinternalip_binding": [ {
      "sitepath":<String_value>,
      "accesstype":<String_value>,
      "translationexternalport":<Integer_value>,
      "translationinternalip":<String_value>,
      "translationexternalip":<String_value>,
      "translationinternalport":<Integer_value>
}]}

<!--NeedCopy-->

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Query-parameters:

    bulkbindings

    http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding? bulkbindings=yes

    NITRO allows you to fetch bindings in bulk.

    Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{  "wisite_translationinternalip_binding": [ {
      "sitepath":<String_value>,
      "accesstype":<String_value>,
      "translationexternalport":<Integer_value>,
      "translationinternalip":<String_value>,
      "translationexternalip":<String_value>,
      "translationinternalport":<Integer_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite_translationinternalip_binding/ sitepath_value<String> ? count=yes

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{"wisite_translationinternalip_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    wisite_translationinternalip_binding
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.