Update a Security Protocol Used in IP Networks
/network/v1/secprotocol/{name}
description
, ipProtocol
, srcPortSet
, dstPortSet
, and tags
parameters of a security protocol.Required Role: To complete this task, you must have the Compute_Operations
role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.
Request
- application/oracle-compute-v3+json
-
name: string
The three-part name of the object (
/Compute-identity_domain/user/object
).
-
Cookie: string
The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.
object
-
description(optional):
string
Description of the security protocol.
-
dstPortSet(optional):
array dstPortSet
Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's destination port matches the ports specified here.
For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no destination ports are specified, all destination ports or ICMP types are allowed.
-
ipProtocol(optional):
string
The protocol used in the data portion of the IP datagram. Specify one of the permitted values or enter a number in the range 0 - 254 to represent the protocol that you want to specify. See Assigned Internet Protocol Numbers. Permitted values are:
tcp
,udp
,icmp
,igmp
,ipip
,rdp
,esp
,ah
,gre
,icmpv6
,ospf
,pim
,sctp
,mplsip
,all
.Traffic is enabled by a security rule when the protocol in the packet matches the protocol specified here. If no protocol is specified, all protocols are allowed.
-
name:
string
The three-part name of the Ip address association (/Compute-identity_domain/user/object).
Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive. When you specify the object name, ensure that an object of the same type and with the same name doesn't already exist. If such an object already exists, another object of the same type and with the same name won't be created and the existing object won't be updated.
-
srcPortSet(optional):
array srcPortSet
Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's source port matches the ports specified here.
For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no source ports are specified, all source ports or ICMP types are allowed.
-
tags(optional):
array tags
Strings that you can use to tag the security protocol.
array
For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no destination ports are specified, all destination ports or ICMP types are allowed.
array
For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no source ports are specified, all source ports or ICMP types are allowed.
Response
- application/oracle-compute-v3+json
200 Response
-
set-cookie: string
The cookie value is returned if the session is extended
object
-
description(optional):
string
Description of the object.
-
dstPortSet(optional):
array dstPortSet
List of port numbers or port range strings to match the packet's destination port.
-
ipProtocol(optional):
string
Protocol used in the data portion of the IP datagram.
-
name(optional):
string
Name of the security protocol.
-
srcPortSet(optional):
array srcPortSet
List of port numbers or port range strings to match the packet's source port.
-
tags(optional):
array tags
Tags associated with the object.
-
uri(optional):
string
Uniform Resource Identifier
array
array
Examples
cURL Command
The following example shows how to update a security protocol, /Compute-acme/jack.jones@example.com/secprotocol1
, by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.
Enter the command on a single line. Line breaks are used in this example for readability.
curl -i -X PUT -H "Cookie: $COMPUTE_COOKIE" -H "Content-Type: application/oracle-compute-v3+json" -H "Accept: application/oracle-compute-v3+json" -d "@requestbody.json" https://api-z999.compute.us0.oraclecloud.com/network/v1/secprotocol/Compute-acme/jack.jones@example.com/secprotocol1
-
COMPUTE_COOKIE
is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication. -
api-z999.compute.us0.oraclecloud.com
is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests. -
acme
andjack.jones@example.com
are example values. Replaceacme
with the identity domain ID of your Compute Classic account, andjack.jones@example.com
with your user name.
Example of Request Body
The following shows an example of the request body content in the requestbody.json
file to update values of the description
, ipProtocol
, srcPortSet
, and dstPortSet
parameters of a security protocol.
{ "name": "/Compute-acme/jack.jones@example.com/secprotocol1", "description": "Updating sample security protocol", "ipProtocol": "udp", "srcPortSet": ["2010-2022"], "dstPortSet": ["2025-2030"] }
Example of Response Body
The following example shows the response body in JSON format when you update a security protocol.
{ "name": "/Compute-acme/jack.jones@example.com/secprotocol1", "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/secprotocol/Compute-acme/jack.jones@example.com/secprotocol1", "description": "Updating sample security protocol", "tags": [], "ipProtocol": "udp", "srcPortSet": ["2010-2022"], "dstPortSet": ["2025-2030"] }