PATCH /networkprofile/{uuid}

PATCH /networkprofile/{uuid}

/networkprofile/{uuid}

Request
URI
PATCH
https://{api_host}/api/networkprofile/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

NetworkProfile object creation

NetworkProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "profile": {
        "type": "string"
    }
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "connection_mirror": false,
    "description": "string",
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "profile": {
        "sctp_fast_path_profile": {
            "enable_init_chunk_protection": false,
            "idle_timeout": 0
        },
        "sctp_proxy_profile": {
            "cookie_expiration_timeout": 0,
            "heartbeat_interval": 0,
            "idle_timeout": 0,
            "max_retransmissions_association": 0,
            "max_retransmissions_init_chunks": 0,
            "number_of_streams": 0,
            "receive_window": 0,
            "reset_timeout": 0
        },
        "tcp_fast_path_profile": {
            "dsr_profile": {
                "dsr_encap_type": "string",
                "dsr_type": "string"
            },
            "enable_syn_protection": false,
            "session_idle_timeout": 0
        },
        "tcp_proxy_profile": {
            "aggressive_congestion_avoidance": false,
            "auto_window_growth": false,
            "automatic": false,
            "cc_algo": "string",
            "congestion_recovery_scaling_factor": 0,
            "idle_connection_timeout": 0,
            "idle_connection_type": "string",
            "ignore_time_wait": false,
            "ip_dscp": 0,
            "keepalive_in_halfclose_state": false,
            "max_retransmissions": 0,
            "max_segment_size": 0,
            "max_syn_retransmissions": 0,
            "min_rexmt_timeout": 0,
            "nagles_algorithm": false,
            "reassembly_queue_size": 0,
            "receive_window": 0,
            "reorder_threshold": 0,
            "slow_start_scaling_factor": 0,
            "time_wait_delay": 0,
            "use_interface_mtu": false
        },
        "type": "string",
        "udp_fast_path_profile": {
            "dsr_profile": {
                "dsr_encap_type": "string",
                "dsr_type": "string"
            },
            "per_pkt_loadbalance": false,
            "session_idle_timeout": 0,
            "snat": false
        },
        "udp_proxy_profile": {
            "session_idle_timeout": 0
        }
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns NetworkProfile of type(s) application/json 
"NetworkProfile Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

object
configpb_attributes
Optional

configpb_attributes

boolean
connection_mirror
Optional

When enabled, Avi mirrors all TCP fastpath connections to standby. Applicable only in Legacy HA Mode. Field introduced in 18.1.3,18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic, Enterprise with Cloud Services edition.

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

The name of the network profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
profile
Required

profile

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the network profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","profile:"object"}'
On This Page
Network Profile Operations
GET
GET /networkprofile
POST
POST /networkprofile
GET
GET /networkprofile/{uuid}
PUT
PUT /networkprofile/{uuid}
PATCH
PATCH /networkprofile/{uuid}
DELETE
DELETE /networkprofile/{uuid}
GET
GET /networkprofile/{uuid}/runtime/internal/