Document Outline

• Contents
• Preface
  • Document conventions
    • Text formatting
    • Command syntax conventions
    • Notes, cautions, and warnings
  • Brocade resources
  • Contacting Brocade Technical Support
  • Document feedback
• About OpenScript
  • Overview
  • General nomenclature of functions
  • Extensions and events
  • Error handling
  • Syntax checking
  • Default action
  • Reducing memory usage
    • Example:
• IP API reference
  • Overview
  • Methods
    • OS_IP::src
    • OS_IP::dst
    • OS_IP::protocol
    • OS_IP::flags
    • OS_IP::tos
    • OS_IP::options
    • OS_IP::getHeaderLength
    • OS_IP::getPayloadLength
    • OS_IP::getOptionsLength
    • OS_IP::raw
• TCP API reference
  • Overview
  • Methods
    • OS_TCP::src
    • OS_TCP::dst
    • OS_TCP::flags
    • OS_TCP::win
    • OS_TCP::seq
    • OS_TCP::ack
    • OS_TCP::options
    • OS_TCP::getHeaderLength
    • OS_TCP::getPayloadLength
    • OS_TCP::getOptionsLength
    • OS_TCP::collect
    • OS_TCP::payload
    • OS_TCP::payload ($data)
• UDP API reference
  • Overview
  • Methods
    • OS_UDP::src
    • OS_UDP::dst
    • OS_UDP::getLength
    • OS_UDP::getPayloadLength
    • OS_UDP::payload
    • OS_UDP::payload ($data)
    • OS_UDP::raw
• HTTP REQUEST API reference
  • Overview
    • Limitation of the content rewrite
  • Methods
    • OS_HTTP_REQUEST::method
    • OS_HTTP_REQUEST::method($val)
    • OS_HTTP_REQUEST::url
    • OS_HTTP_REQUEST::url($val)
    • OS_HTTP_REQUEST::path
    • OS_HTTP_REQUEST::path($val)
    • OS_HTTP_REQUEST::query
    • OS_HTTP_REQUEST::query($val)
    • OS_HTTP_REQUEST::url_extension
    • OS_HTTP_REQUEST::version
    • OS_HTTP_REQUEST::version($val)
    • OS_HTTP_REQUEST::header($name)
    • OS_HTTP_REQUEST::header($name, $value)
    • OS_HTTP_REQUEST::headers($name)
    • OS_HTTP_REQUEST::host
    • OS_HTTP_REQUEST::host($value)
    • OS_HTTP_REQUEST::collect
    • OS_HTTP_REQUEST::content
    • OS_HTTP_REQUEST::content($value)
    • OS_HTTP_REQUEST::push_header($name, $value)
    • OS_HTTP_REQUEST::remove_header($name)
    • OS_HTTP_REQUEST::remove_all_headers($name)
    • OS_HTTP_REQUEST::content_type
    • OS_HTTP_REQUEST::content_length
    • OS_HTTP_REQUEST::cookie ($name)
    • OS_HTTP_REQUEST::cookie ($name, $value)
    • OS_HTTP_REQUEST::cookie_count
    • OS_HTTP_REQUEST::cookie_persist("name"=>$cookie_name, "domain"=>$domain, "path"=>$path, "age"=>$age)
    • OS_HTTP_REQUEST::redirect("domain"=>$domain_value, "status- code"=>$status_code, "url"=>$url_value, "port"=>$port_value)
    • OS_HTTP_REQUEST::headers_as_string
• HTTP RESPONSE API reference
  • Overview
    • Limitation of the content rewrite
  • Methods
    • OS_HTTP_RESPONSE::code
    • OS_HTTP_RESPONSE::code ($val)
    • OS_HTTP_RESPONSE::version
    • OS_HTTP_RESPONSE::version ($val)
    • OS_HTTP_RESPONSE::header ($name)
    • OS_HTTP_RESPONSE::header ($name, $value)
    • OS_HTTP_RESPONSE::headers($name)
    • OS_HTTP_RESPONSE::collect
    • OS_HTTP_RESPONSE::content
    • OS_HTTP_RESPONSE::content($value)
    • OS_HTTP_RESPONSE::push_header ($name, $val)
    • OS_HTTP_RESPONSE::remove_header ($name)
    • OS_HTTP_RESPONSE::remove_all_headers($name)
    • OS_HTTP_RESPONSE::content_type
    • OS_HTTP_RESPONSE::content_length
    • OS_HTTP_RESPONSE::cookie ($name)
    • OS_HTTP_RESPONSE::cookie ($name, $value)
    • OS_HTTP_RESPONSE::cookie_version ($name)
    • OS_HTTP_RESPONSE::cookie_version ($name, $value)
    • OS_HTTP_RESPONSE::cookie_path ($name)
    • OS_HTTP_RESPONSE::cookie_path ($name, $value)
    • OS_HTTP_RESPONSE::cookie_domain($name)
    • OS_HTTP_RESPONSE::cookie_domain($name, $value)
    • OS_HTTP_RESPONSE::cookie_port ($name)
    • OS_HTTP_RESPONSE::cookie_port ($name, $value)
    • OS_HTTP_RESPONSE::cookie_maxage ($name)
    • OS_HTTP_RESPONSE::cookie_maxage ($name, $value)
    • OS_HTTP_RESPONSE::cookie_expiration($name)
    • OS_HTTP_RESPONSE::cookie_expiration($name, $value)
    • OS_HTTP_RESPONSE::cookie_comment($name)
    • OS_HTTP_RESPONSE::cookie_comment($name, $value)
    • OS_HTTP_RESPONSE::cookie_count
    • OS_HTTP_RESPONSE::headers_as_string
• Server Load Balancing API Reference
  • Overview
  • Methods
    • OS_SLB:: server_name($id)
    • OS_SLB:: server_id($name, $port)
    • OS_SLB:: servers($group_id)
    • OS_SLB::is_server_up("server-name"=>$name, "server-id"=>$id, "port"=>$port)
    • OS_SLB:: get_server_current_connections($name)
    • OS_SLB:: get_server_port_current_connections ($name, $port)
    • OS_SLB:: is_client_ssl
    • OS_SLB:: is_server_ssl
    • OS_SLB:: persist($method, $string)
    • OS_SLB:: passive_persist($method, $string)
    • OS_SLB:: persist_lookup($method, $string)
    • OS_SLB:: reply($data)
    • OS _SLB:: reset_client
    • OS _SLB:: log($log_string)
    • OS _SLB:: drop
    • OS _SLB:: forward($server)
    • OS _SLB:: send_to_client
    • OS _SLB:: send_to_server
    • OS _SLB:: is_group_up($group-id)
    • OS _SLB:: virtual_server_name()
• Connection API Reference
  • Overview
  • Methods
    • OS_CONN::client_connection
• Content Inspection API Reference
  • OS_PAYLOAD_INSPECT module overview
    • Content Inspection API considerations
  • Methods
    • OS_PAYLOAD_INSPECT::substitute(regexp1, string1, [regexp2, string2 …])
    • OS_PAYLOAD_INSPECT::match(regexp1, [regexp2 …])
    • OS_PAYLOAD_INSPECT::matched_replace(mstr1, rstr1, [mstr2, rstr2, …])
    • OS_PAYLOAD_INSPECT::match_size(integer)
    • OS_PAYLOAD_INSPECT::disable ()
    • OS_PAYLOAD_INSPECT::matched_str ()
    • OS_PAYLOAD_INSPECT::matched_idx ()